ドキュメント用REST API

機械翻訳について

ファイル・コピー

post

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

指定したファイルを、指定された対象フォルダにコピーします。

リクエスト

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

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は必須の値を示します。

ルート・スキーマ: FileCopyBody

タイプ: object

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

ソースを表示

destinationID: string

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

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

(オプション)コピーするファイルのバージョン番号を指定します。バージョンが指定されていない場合は、最新バージョンが使用されます。

{
    "description":"<p>The request body defines the details of the copy 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."
        },
        "version":{
            "type":"string",
            "description":"(Optional) Specify the version number of the file to copy. If the version is not specified, the latest version is used."
        },
        "duplicateResolution":{
            "type":"string",
            "description":"(Optional) Specify the <code>TimeStampSuffix</code> option. The name of the copied file is given a 6-digit suffix from the system timestamp."
        }
    },
    "required":[
        "destinationID"
    ]
}

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

{
    "destinationID":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "version":1
}

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ : FileCopyResponse

タイプ: object

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

ソースを表示

destinationID(optional): string

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

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

新規作成するファイルのグローバル一意識別子(GUID)
idList(optional): string

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

アイテム・タイプfile。

{
    "description":"The response body includes information about the copied file.",
    "properties":{
        "destinationID":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the destination folder."
        },
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the newly created file."
        },
        "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",
    "id":"D4018B1EF3AC07D0A349DB8DT0000000000100000001",
    "idList":"D574378400573ED9D62B3195T0000000000100000001",
    "type":"file",
    "errorCode":"0"
}

400レスポンス

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

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定したファイルのコピーを指定した宛先フォルダに作成します。

POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/copy

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "destinationID": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "version": "1"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

例2

次の例では、指定されたファイル(バージョン2)のコピーを指定された宛先フォルダに作成します。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、パブリック・リンクIDを使用します。

POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/copy

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "version": "2"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

例3

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

POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/copy

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "version": "2"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

例4

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

POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/copy

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "version": "2"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

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

例5

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

POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/copy

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "version": "2"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "errorCode": "-18",
    "errorKey": "!csFldUnableToCopyItems!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "Unable to copy items. The access code must be provided to access the link.",
    "errorType": "file",
    "idList": "DBFC40982617C949CA373B08B5D17B95F47087F4E518",
    "title": "Unable to copy items. The access code must be provided to access the link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "version": "2"
}

例6

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

POST .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/copy

リクエスト・ヘッダー

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

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "version": "2"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "errorCode": "0",
    "id": "DABECC242E4FDCFB90C80FFBB5D17B95F47087F4E518",
    "idList": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "type": "file"
}

先頭に戻る