ドキュメント用REST API

機械翻訳について

フォルダ・コピー

post

/documents/api/1.2/folders/{folderId}/copy

指定したフォルダとその内容を、指定された対象フォルダにコピーします。

リクエスト

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

application/json
application/xml

パス・パラメータ

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

ルート・スキーマ: FolderCopyBody

タイプ: object

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

ソースを表示

destinationID: string

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

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

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

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

{
    "destinationID":"FB4CD874EF94CD2CC1B60B72T0000000000100000001"
}

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ: FolderCopyResponse

タイプ: object

ソースを表示

destinationID(optional): string

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

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

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

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

アイテム・タイプfolder。

{
    "description":"",
    "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 folder."
        },
        "idList":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the original folder."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>folder</code>."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

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

{
    "destinationID":"FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "id":"FCD4D4A73FA2317583B7C3BFT0000000000100000001",
    "idList":"F512DA3911603E8AB84A07ACT0000000000100000001",
    "type":"folder",
    "errorCode":"0"
}

400レスポンス

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

403レスポンス

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

404レスポンス

フォルダIDが見つかりません。

トップに戻る

例

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

POST .../folders/F512DA3911603E8AB84A07ACT0000000000100000001/copy

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "destinationID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "destinationID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "errorCode": "0",
    "id": "FCD4D4A73FA2317583B7C3BFT0000000000100000001",
    "idList": "F512DA3911603E8AB84A07ACT0000000000100000001",
    "type": "folder"
}

例2

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

POST .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518/copy

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "errorCode": "0",
    "id": "F140C834BF9484B69B26383AB5D17B95F47087F4E518",
    "idList": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "type": "folder"
}

例3

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

POST .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518/copy

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518",
    "errorCode": "0",
    "id": "F140C834BF9484B69B26383AB5D17B95F47087F4E518",
    "idList": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "type": "folder"
}

例4

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

POST .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518/copy

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

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

例5

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

POST .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518/copy

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518"
}

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": "folder",
    "idList": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "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"
}

例6

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

POST .../folders/F64529EF770DCF96F029ED82B5D17B95F47087F4E518/copy

リクエスト・ヘッダー

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

リクエスト本文

{
    "destinationID": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "destinationID": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "errorCode": "0",
    "id": "F62E96098A6F9186F94730C1B5D17B95F47087F4E518",
    "idList": "F64529EF770DCF96F029ED82B5D17B95F47087F4E518",
    "type": "folder"
}

先頭に戻る