フォルダを作成

post
https://api.box.com/2.0
/folders

指定した親フォルダ内に空のフォルダを新規に作成します。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

string arrayクエリ内省略可能
id,type,name

応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。

リクエスト本文

object本文内

このオブジェクトを設定するとアップロードメールアドレスが有効になります。

ユーザーはこのメールアドレスを使用することにより、メールを介して フォルダにファイルを直接アップロードできます。

stringnull省略可能
open

このパラメータが設定されている場合、 ユーザーは、このフォルダに対して自動的に作成されたメールアドレスに メールでファイルを送信できます。

メールアドレスを作成するには、フォルダを作成するとき、または更新するときに このプロパティを設定します。

collaboratorsに設定すると、コラボレータの登録済み メールアドレスからのメールのみが受け入れられます。 これには、ユーザーが登録しているすべてのメールエイリアスも含まれます。

openに設定すると、どのメールアドレスからのメールでも 受け入れられます。

次の値のいずれか1つ: open,collaborators

string本文内必須
New Folder255

新しいフォルダの名前。

ファイル名にはいくつかの制約があります。印刷不可能なASCII文字、スラッシュ、およびバックスラッシュ(/\)を含む名前、または末尾にスペースを含む名前は禁止されています。

また、.および..という名前も使用できません。

object本文内

新しいフォルダの作成先となる親フォルダ。

stringnull省略可能
0

親フォルダのID

string本文内省略可能
synced

フォルダをユーザーのデバイスに同期する必要があるかどうかを指定します。 これはBox Sync(廃止済み)で使用され、Box Driveでは 使用されません。

次の値のいずれか1つ: synced,not_synced,partially_synced

レスポンス

application/jsonFolder (標準)

フォルダオブジェクトを返します。

使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、fieldsクエリパラメータを使用します。

一部のパラメータが指定されていないか無効な場合はエラーを返します。

  • bad_request - パラメータが指定されていないか誤っている場合に返されます。
  • item_name_too_long - フォルダ名が長すぎる場合に返されます。
  • item_name_invalid - フォルダ名に無効な文字が含まれている場合に返されます。

ユーザーにこのアクションを実行するための アクセス権限がない場合にエラーは返します。 これは、ユーザーにフォルダまたは親フォルダへのアクセス権限がないか、 アプリケーションにファイルおよびフォルダへの書き込み権限がないことが 原因となっている可能性があります。

親フォルダが見つからないか、 認証済みユーザーが親フォルダに アクセスできない場合はエラーを返します。

  • not_found - 認証済みユーザーが親フォルダにアクセスできない場合に 返されます
  • operation_blocked_temporary: 別の移動、コピー、削除、 または復元操作が進行中であるために宛先フォルダまたは元のフォルダが ロックされている場合に返されます。

    操作は後で再試行することができます。

  • item_name_in_use: この名前のフォルダがすでに親フォルダ内に存在している場合に 返されます。

予期しないクライアントエラー。

post
フォルダを作成
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -X POST https://api.box.com/2.0/folders \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
     -H 'Content-Type: application/json" '
     -d '{
       "name": "New Folder",
       "parent": {
         "id": "0"
       }
     }'
.NET
// Create a new folder in the user's root folder
var folderParams = new BoxFolderRequest()
{
    Name = "New folder",
    Parent = new BoxRequestEntity()
    {
        Id = "0"
    }
};
BoxFolder folder = client.FoldersManager.CreateAsync(folderParams);
Java
BoxFolder parentFolder = new BoxFolder(api, "id");
BoxFolder.Info childFolderInfo = parentFolder.createFolder("Child Folder Name");
Python
subfolder = client.folder('0').create_subfolder('My Stuff')
print('Created subfolder with ID {0}'.format(subfolder.id))
Node
client.folders.create('0', 'New Folder')
    .then(folder => {
        /* folder -> {
            type: 'folder',
            id: '123456',
            sequence_id: '0',
            etag: '0',
            name: 'New Folder',
            created_at: '2012-12-12T10:53:43-08:00',
            modified_at: '2012-12-12T11:15:04-08:00',
            description: '',
            size: 0,
            path_collection: 
            { total_count: 1,
                entries: 
                [ { type: 'folder',
                    id: '0',
                    sequence_id: null,
                    etag: null,
                    name: 'All Files' } ] },
            created_by: 
            { type: 'user',
                id: '22222',
                name: 'Example User'
                login: 'user@example.com' },
            modified_by: 
            { type: 'user',
                id: '22222',
                name: 'Example User',
                login: 'user@example.com' },
            owned_by: 
            { type: 'user',
                id: '22222',
                name: 'Example User',
                login: 'user@example.com' },
            shared_link: null,
            parent: 
            { type: 'folder',
                id: '0',
                sequence_id: null,
                etag: null,
                name: 'All Files' },
            item_status: 'active',
            item_collection: 
            { total_count: 0,
                entries: [],
                offset: 0,
                limit: 100 } }
        */
    });
iOS
client.folders.create(name: "New Folder", parentId: "22222") { (result: Result<Folder, BoxSDKError>) in
    guard case let .success(folder) = result else {
        print("Error creating folder")
        return
    }

    print("Created folder \"\(folder.name)\" inside of folder \"\(folder.parent.name)\"")
}

レスポンスの例

{}