機械翻訳について
  1. ドキュメント用REST API
  2. タスク
  3. フォルダ

フォルダ編集

put

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

指定したフォルダの名前や説明を変更します。

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
ヘッダー・パラメータ

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

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

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

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

本文 ()
リクエスト本文では、フォルダ編集リクエストの詳細を定義します。 必須の属性はありません。
ルート・スキーマ: FolderEditBody
タイプ: object
リクエスト本文では、フォルダ編集リクエストの詳細を定義します。 必須の属性はありません。
ソースを表示
リクエストの例(application/json)
{
    "name":"backup",
    "description":"my backup folder"
}
トップに戻る

レスポンス

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

200レスポンス

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

本文 ()
ルート・スキーマ: FolderResponse
タイプ: object
レスポンス本文には、フォルダに関する情報が含まれます。
ソースを表示
すべてに一致
ソースを表示
ネストされたスキーマ: FolderDefinition
タイプ: object
フォルダのメタデータ情報。
ソースを表示
ネストされたスキーマ: User
タイプ: object
ユーザー情報
ソースを表示
レスポンスの例(application/json)
{
    "id":"F512DA3911603E8AB84A07ACT0000000000100000001",
    "parentID":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "name":"backup",
    "description":"my backup folder",
    "type":"folder",
    "size":"0",
    "childItemsCount":"0",
    "createdTime":"2014-02-21T20:56:07Z",
    "modifiedTime":"2014-02-21T20:59:57Z",
    "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 .../folders/F512DA3911603E8AB84A07ACT0000000000100000001

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "name": "backup",
    "description": "my backup folder"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "0",
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T20:56:07Z",
    "description": "my backup folder",
    "errorCode": "0",
    "id": "F512DA3911603E8AB84A07ACT0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T20:59:57Z",
    "name": "backup",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "size": "0",
    "type": "folder"
}

例2

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

PUT .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "name": "UserBBFolderUpdated",
    "description": "User BB folder created via public link - updated"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "0",
    "createdBy": {
        "displayName": "User BB",
        "loginName": "userBBLoginName",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "type": "user"
    },
    "createdTime": "2016-06-30T23:34:21Z",
    "description": "User BB folder created via public link - updated",
    "errorCode": "0",
    "id": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "modifiedBy": {
        "displayName": "User BB",
        "loginName": "userBBLoginName",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2016-06-30T23:42:44Z",
    "name": "UserBBFolderUpdated",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
    "size": "0",
    "type": "folder"
}

例3

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

PUT .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

{
    "name": "UserBBFolderUpdated",
    "description": "User BB folder created via public link - updated"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "0",
    "createdBy": {
        "displayName": "User BB",
        "loginName": "userBBLoginName",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "type": "user"
    },
    "createdTime": "2016-06-30T23:34:21Z",
    "description": "User BB folder created via public link - updated",
    "errorCode": "0",
    "id": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "modifiedBy": {
        "displayName": "User BB",
        "loginName": "userBBLoginName",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2016-06-30T23:42:44Z",
    "name": "UserBBFolderUpdated",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
    "size": "0",
    "type": "folder"
}

例4

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

PUT .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "name": "UserBBFolderUpdated",
    "description": "User BB folder created via public link - updated"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "description": "User BB folder created via public link - updated",
    "errorCode": "-20",
    "errorKey": "!csFldUnableToEditFolder!csCloudItemInsufficientPrivileges,User BB,fFolderGUID:F81175D40FF57F19884AED0CB5D17B95F47087F4E518,FLD_EDIT_FOLDER",
    "errorMessage": "Unable to edit folder. User 'User BB' has insufficient privilege to access fFolderGUID:F81175D40FF57F19884AED0CB5D17B95F47087F4E518 with service FLD_EDIT_FOLDER.",
    "errorType": "folder",
    "id": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "name": "UserBBFolderUpdated",
    "title": "Unable to edit folder. User 'User BB' has insufficient privilege to access fFolderGUID:F81175D40FF57F19884AED0CB5D17B95F47087F4E518 with service FLD_EDIT_FOLDER.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例5

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

PUT .../folders/F81175D40FF57F19884AED0CB5D17B95F47087F4E518

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "name": "UserBBFolderUpdated",
    "description": "User BB folder created via public link - updated"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "description": "User BB folder created via public link - updated",
    "errorCode": "-18",
    "errorKey": "!csFldUnableToEditFolder!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "Unable to edit folder. The access code must be provided to access the link.",
    "errorType": "folder",
    "id": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
    "name": "UserBBFolderUpdated",
    "title": "Unable to edit folder. 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 .../folders/F64529EF770DCF96F029ED82B5D17B95F47087F4E518

リクエスト・ヘッダー

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

リクエスト本文

{
    "description": "subFolderTestByUserB CONTRIBUTOR applink - EDITED"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "1",
    "createdBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2017-06-16T18:10:05Z",
    "description": "subFolderTestByUserB CONTRIBUTOR applink - EDITED",
    "errorCode": "0",
    "id": "F64529EF770DCF96F029ED82B5D17B95F47087F4E518",
    "modifiedBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2017-06-19T20:11:33Z",
    "name": "subFolderTestByUserB",
    "ownedBy": {
        "displayName": "User AA",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "parentID": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "size": "0",
    "type": "folder"
}
先頭に戻る