ドキュメント用REST API

機械翻訳について

ファイル移動

post

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

指定したファイルとそのバージョンを、指定された対象フォルダに移動します。移動したファイルでは、グローバルに一意の識別子とすべての日付および所有権情報が保持されます。

リクエスト

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

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

リクエスト本文では、ファイル移動リクエストの詳細を定義します。 Boldは必須の値を示します。

ルート・スキーマ: FileMoveBody

タイプ: object

リクエスト本文では、ファイル移動リクエストの詳細を定義します。 Boldは必須の値を示します。

ソースを表示

destinationID: string

(必須)宛先フォルダのグローバル一意識別子(GUID)を指定します。
duplicateResolution(optional): string

(オプション)TimeStampSuffixオプションを指定します。移動されたファイルの名前には、システムのタイムスタンプから6桁の数字の接尾辞が付与されます。

{
    "description":"<p>The request body defines the details of the move file request. <b>Bold</b> indicates a required value.</p>",
    "properties":{
        "destinationID":{
            "type":"string",
            "description":"(Required) Specify the globally unique identifier (GUID) of the destination folder."
        },
        "duplicateResolution":{
            "type":"string",
            "description":"(Optional) Specify the <code>TimeStampSuffix</code> option. The name of the moved file is given a 6-digit suffix from the system timestamp."
        }
    },
    "required":[
        "destinationID"
    ]
}

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

{
    "destinationID":"FF4729683CD68C1AFB1AE87DT0000000000100000001"
}

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ: FileMoveResponse

タイプ: object

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

ソースを表示

destinationID(optional): string

対象フォルダのグローバル一意識別子(GUID)
errorCode(optional): number

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

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

アイテム・タイプfile。

{
    "description":"The response body includes information about the move operation.",
    "properties":{
        "destinationID":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the destination folder."
        },
        "idList":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the original 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)

{
    "destinationID":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "idList":"D574378400573ED9D62B3195T0000000000100000001",
    "type":"file",
    "errorCode":"0"
}

400レスポンス

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

403レスポンス

ユーザーが移動したファイルの読み取り権限を持っていないか、または移動先フォルダの書き込み権限がない場合は禁止されます。

404レスポンス

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

トップに戻る

例

次の例では、指定したファイルを指定した移動先に移動します。

POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/move

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "destinationID": "FF4729683CD68C1AFB1AE87DT0000000000100000001"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "destinationID": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "errorCode": "0",
    "idList": "D4018B1EF3AC07D0A349DB8DT0000000000100000001",
    "type": "file"
}

例2

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

POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/move

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "errorCode": "0",
    "idList": "D4018B1EF3AC07D0A349DB8DT0000000000100000001",
    "type": "file"
}

例3

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

POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/move

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "errorCode": "0",
    "idList": "D4018B1EF3AC07D0A349DB8DT0000000000100000001",
    "type": "file"
}

例4

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

POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/move

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "errorCode": "-20",
    "errorKey": "!csFldUnableToMoveItems!csCloudItemInsufficientPrivileges,User BB,fFileGUID:D4018B1EF3AC07D0A349DB8DT0000000000100000001,FLD_MOVE",
    "errorMessage": "Unable to move items. User 'User BB' has insufficient privilege to access fFileGUID:D4018B1EF3AC07D0A349DB8DT0000000000100000001 with service FLD_MOVE.",
    "errorType": "file",
    "idList": "D4018B1EF3AC07D0A349DB8DT0000000000100000001",
    "title": "Unable to move items. User 'User BB' has insufficient privilege to access fFileGUID:D4018B1EF3AC07D0A349DB8DT0000000000100000001 with service FLD_MOVE.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例5

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

POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/move

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "errorCode": "-18",
    "errorKey": "!csFldUnableToMoveItems!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "Unable to move items. The access code must be provided to access the link.",
    "errorType": "file",
    "idList": "D4018B1EF3AC07D0A349DB8DT0000000000100000001",
    "title": "Unable to move items. 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とアクセス・トークンはリクエスト・ヘッダーに送信されます。

POST .../files/DABECC242E4FDCFB90C80FFBB5D17B95F47087F4E518/move

リクエスト・ヘッダー

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

リクエスト本文

{
    "destinationID": "FD1897615847AA802783B996B5D17B95F47087F4E518"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "destinationID": "FD1897615847AA802783B996B5D17B95F47087F4E518",
    "errorCode": "0",
    "idList": "DABECC242E4FDCFB90C80FFBB5D17B95F47087F4E518",
    "type": "file"
}

先頭に戻る