機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

フォルダの一括作成

post

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

単一の親フォルダの下にフォルダの一括作成をリクエストします。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• folderId: string

  フォルダのグローバル一意識別子(GUID)。 このリクエストで作成されたすべてのサブフォルダの親フォルダです。 参照されるフォルダがユーザーのホーム・フォルダの場合、folderIdの値はselfです。

問合せパラメータ

• links(optional): string

  作成したフォルダのリンクをレスポンスで返すかどうかを指定します。 値links=trueは、作成されたフォルダごとに使用可能なすべてのリンクを返します。 その他の値、またはlinksを送信しない場合、リンクは返されません。

ヘッダー・パラメータ

• accessToken(optional): string

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

• appLinkID(optional): string

  現在のユーザーにこのフォルダへのアクセスを許可するApplink ID。 パラメータappLinkIDが使用されるときはいつでも、パラメータaccessTokenも提供されなければなりません。 appLinkIDまたはAppLinkIDとして使用できます。

• dAccessCode(optional): string

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

• linkID(optional): string

  現在のユーザーにこのフォルダへのアクセスを許可する、パブリック・リンクのパブリック・リンクID。 linkIDまたはLinkIDとして使用できます。

本文 ()

リクエスト本文では、作成するサブフォルダの詳細を定義します。

ルート・スキーマ : FolderBulkCreateBody

タイプ: object

リクエスト本文では、フォルダの一括作成リクエストの詳細を定義します。

ソースを表示

• folders: array folders
  最小アイテム数: 1

  最大アイテム数: 50

  (必須)同じ親の下に作成されるフォルダのリスト。 リクエストごとに最大50個のフォルダを使用できます。

{
    "description":"The request body defines details of bulk create folder request.",
    "properties":{
        "folders":{
            "type":"array",
            "description":"(Required) The list of folders to be created under the same parent. A maximum of 50 folders is allowed per request.",
            "items":{
                "$ref":"#/definitions/FolderBulkCreateBodyArrayItem"
            },
            "minItems":1,
            "maxItems":50
        }
    },
    "required":[
        "folders"
    ]
}

ネストされたスキーマ: folders

タイプ: array

最小アイテム数: 1

最大アイテム数: 50

(必須)同じ親の下に作成されるフォルダのリスト。 リクエストごとに最大50個のフォルダを使用できます。

ソースを表示

• Array of: object FolderBulkCreateBodyArrayItem
  リクエスト本文では、フォルダの一括作成リクエストの詳細を定義します。 Boldは必須の値を示します。

{
    "type":"array",
    "description":"(Required) The list of folders to be created under the same parent. A maximum of 50 folders is allowed per request.",
    "items":{
        "$ref":"#/definitions/FolderBulkCreateBodyArrayItem"
    },
    "minItems":1,
    "maxItems":50
}

ネストされたスキーマ : FolderBulkCreateBodyArrayItem

タイプ: object

リクエスト本文では、フォルダの一括作成リクエストの詳細を定義します。 Boldは必須の値を示します。

ソースを表示

• description(optional): string
  最大長: 2000

  (オプション)新規作成するフォルダの説明を指定します。
• name: string
  最大長: 255

  (必須)新規作成するフォルダの名前を指定します。

{
    "description":"The request body defines details of the bulk create folder request. <b>Bold</b> indicates a required value.",
    "properties":{
        "name":{
            "type":"string",
            "description":"(Required) Specify the name of the newly created folder.",
            "maxLength":255
        },
        "description":{
            "type":"string",
            "description":"(Optional) Specify a description for the newly created folder.",
            "maxLength":2000
        }
    },
    "required":[
        "name"
    ]
}

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

{
    "folders":[
        {
            "name":"folder 1",
            "description":"folder 1 description"
        },
        {
            "name":"folder 2",
            "description":"folder 2 description"
        },
        {
            "name":"folder 3",
            "description":"folder 3 description"
        }
    ]
}

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

レスポンス本文には、一括フォルダ作成結果に関する情報が含まれます。

本文 ()

ルート・スキーマ : FolderBulkCreateResponse

タイプ: object

レスポンス本文には、作成されているすべてのフォルダに関する情報が含まれます。

ソースを表示

• errorCode(optional): string
  エラー・コードがゼロ(0)の場合は、エラーなしです
• items(optional): array items
  フォルダに作成されるサブフォルダ。

{
    "description":"The response body includes information about all created folders.",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "items":{
            "type":"array",
            "description":"The subfolders created in the folder.",
            "items":{
                "$ref":"#/definitions/BulkCreateFoldersItemsDefinition"
            }
        }
    }
}

ネストされたスキーマ: items

タイプ: array

フォルダに作成されるサブフォルダ。

ソースを表示

• Array of: object BulkCreateFoldersItemsDefinition
  フォルダに作成されるサブフォルダ。

{
    "type":"array",
    "description":"The subfolders created in the folder.",
    "items":{
        "$ref":"#/definitions/BulkCreateFoldersItemsDefinition"
    }
}

ネストされたスキーマ : BulkCreateFoldersItemsDefinition

タイプ: object

フォルダに作成されるサブフォルダ。

ソースを表示

• childFileCount(optional): string
  フォルダに含まれるファイルの数。
• childFolderCount(optional): string
  フォルダに含まれるフォルダの数。
• childItemsCount(optional): string
  フォルダに含まれるファイルおよびフォルダの数。
• createdBy(optional): object User
  ユーザー情報
• createdTime(optional): string
  フォルダが作成された日付
• description(optional): string
  フォルダの説明。
• id(optional): string
  フォルダのグローバル一意識別子(GUID)。
• links(optional): array links
  フォルダのリンク。
• modifiedBy(optional): object User
  ユーザー情報
• modifiedTime(optional): string
  フォルダが最終的に更新された日付
• name(optional): string
  フォルダ名。
• ownedBy(optional): object User
  ユーザー情報
• parentID(optional): string

  親フォルダのグローバル一意識別子(GUID)。 親フォルダがユーザーのホーム・フォルダの場合、parentIDの値はselfです。

• size(optional): string
  含まれるファイルとフォルダをすべて含めたフォルダのサイズ(バイト単位)
• type(optional): string
  アイテム・タイプfolder。

{
    "description":"The subfolders created in the folder.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the folder."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>folder</code>."
        },
        "name":{
            "type":"string",
            "description":"Folder name."
        },
        "description":{
            "type":"string",
            "description":"Folder description."
        },
        "parentID":{
            "type":"string",
            "description":"<p>Globally unique identifier (GUID) for the parent folder. If the parent  folder is the user&#39;s home folder, the value for <code>parentID</code> is <code>self</code>.</p>"
        },
        "createdTime":{
            "type":"string",
            "description":"Date the folder was created."
        },
        "modifiedTime":{
            "type":"string",
            "description":"Date the folder was last modified."
        },
        "childItemsCount":{
            "type":"string",
            "description":"Number of files and folders contained in the folder."
        },
        "childFolderCount":{
            "type":"string",
            "description":"Number of folders contained in the folder."
        },
        "childFileCount":{
            "type":"string",
            "description":"Number of files contained in the folder."
        },
        "size":{
            "type":"string",
            "description":"Size of the folder in bytes, including all of the files and folders contained in the folder."
        },
        "createdBy":{
            "$ref":"#/definitions/User"
        },
        "modifiedBy":{
            "$ref":"#/definitions/User"
        },
        "ownedBy":{
            "$ref":"#/definitions/User"
        },
        "links":{
            "type":"array",
            "description":"Links for the folder.",
            "items":{
                "$ref":"#/definitions/FoldersLinkDetails"
            }
        }
    }
}

ネストされたスキーマ: User

タイプ: object

ユーザー情報

ソースを表示

• displayName(optional): string
  ユーザーの表示名
• id(optional): string
  ユーザーのグローバル一意識別子(GUID)。
• loginName(optional): string
  ユーザーのログイン名。
• type(optional): string
  アイテム・タイプuser。

{
    "description":"User information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

ネストされたスキーマ: links

タイプ: array

フォルダのリンク。

ソースを表示

• Array of: object FoldersLinkDetails
  フォルダのリンク。

{
    "type":"array",
    "description":"Links for the folder.",
    "items":{
        "$ref":"#/definitions/FoldersLinkDetails"
    }
}

ネストされたスキーマ : FoldersLinkDetails

タイプ: object

フォルダのリンク。

ソースを表示

• href(optional): string
  リンク・タイプに対応するURL。
• rel(optional): string
  リンクのタイプ。これはself, canonical, parentおよびchildです

{
    "description":"Links for a folder.",
    "properties":{
        "rel":{
            "type":"string",
            "description":"The type of link, this will be <code>self</code>, <code>canonical</code>, <code>parent</code> and <code>child</code>"
        },
        "href":{
            "type":"string",
            "description":"The URL corresponding to the link type."
        }
    }
}

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

{
    "errorCode":0,
    "items":[
        {
            "id":"F31BB7F92F167752A3AB5EAC47440630DCC4D63610C1",
            "type":"folder",
            "name":"folder 1",
            "description":"folder 1 description",
            "parentID":"F1564DFB2D7C7FBE8EE7A38CACF5DA9752E1734D9F36",
            "createdTime":"2021-03-11T21:32:45Z",
            "modifiedTime":"2021-03-11T21:32:45Z",
            "childItemsCount":"0",
            "childFolderCount":"0",
            "childFileCount":"0",
            "size":"0",
            "createdBy":{
                "displayName":"User AA",
                "loginName":"userAALoginName",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "type":"user"
            },
            "modifiedBy":{
                "displayName":"User AA",
                "loginName":"userAALoginName",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "type":"user"
            },
            "ownedBy":{
                "displayName":"User AA",
                "loginName":"userAALoginName",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "type":"user"
            }
        },
        {
            "id":"F29815ADE851DA3F9A07D6EA85BD0AE9B8B03D7D2718",
            "type":"folder",
            "name":"folder 2",
            "description":"folder 2 description",
            "parentID":"F1564DFB2D7C7FBE8EE7A38CACF5DA9752E1734D9F36",
            "createdTime":"2021-03-11T21:32:45Z",
            "modifiedTime":"2021-03-11T21:32:45Z",
            "childItemsCount":"0",
            "childFolderCount":"0",
            "childFileCount":"0",
            "size":"0",
            "createdBy":{
                "displayName":"User AA",
                "loginName":"userAALoginName",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "type":"user"
            },
            "modifiedBy":{
                "displayName":"User AA",
                "loginName":"userAALoginName",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "type":"user"
            },
            "ownedBy":{
                "displayName":"User AA",
                "loginName":"userAALoginName",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "type":"user"
            }
        },
        {
            "id":"F1275FD876ED265557E8B6D45C09A67B319C4BA8294A",
            "type":"folder",
            "name":"folder 3",
            "description":"folder 3 description",
            "parentID":"F1564DFB2D7C7FBE8EE7A38CACF5DA9752E1734D9F36",
            "createdTime":"2021-03-11T21:32:45Z",
            "modifiedTime":"2021-03-11T21:32:45Z",
            "childItemsCount":"0",
            "childFolderCount":"0",
            "childFileCount":"0",
            "size":"0",
            "createdBy":{
                "displayName":"User AA",
                "loginName":"userAALoginName",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "type":"user"
            },
            "modifiedBy":{
                "displayName":"User AA",
                "loginName":"userAALoginName",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "type":"user"
            },
            "ownedBy":{
                "displayName":"User AA",
                "loginName":"userAALoginName",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "type":"user"
            }
        }
    ]
}

400レスポンス

返されたエラーの説明に従い、リクエストは無効です。

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、1つの親フォルダの下に2つのサブフォルダを作成します。 このリクエストは、作成された各フォルダのリンクも返します。

POST.../folders/FC36AAB4D623FC51477DC6C456897E7E77B1313A2E41/_bulkCreate?links=true

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "folders" : [
        { "name" : "sub folder 1", "description" : "description for folder 1"},
        { "name" : "sub folder 2", "description" : "description for folder 2"}
    ]
}

HTTPステータス・コード

HTTP_STATUS = 201

JSONレスポンス

{
    "errorCode": "0",
    "items": [
        {
            "id": "F6D00906682BEE445AE023D9A74012C07F07B9C4E3A0",
            "type": "folder",
            "name": "sub folder 1",
            "description": "description for folder 1",
            "parentID": "F1564DFB2D7C7FBE8EE7A38CACF5DA9752E1734D9F36",
            "createdTime": "2021-03-15T22:13:43Z",
            "modifiedTime": "2021-03-15T22:13:43Z",
            "childItemsCount": "0",
            "childFolderCount": "0",
            "childFileCount": "0",
            "createdBy": {
                "displayName": "User AA",
                "id": "UCC2702CD5AED3F95DBB8FD8EBD09207B89C",
                "loginName": "userAALoginName",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "id": "UCC2702CD5AED3F95DBB8FD8EBD09207B89C",
                "loginName": "userAALoginName",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "id": "UCC2702CD5AED3F95DBB8FD8EBD09207B89C",
                "loginName": "userAALoginName",
                "type": "user"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "[OCEHost]/documents/api/1.2/folders/F6D00906682BEE445AE023D9A74012C07F07B9C4E3A0"
                },
                {
                    "rel": "canonical",
                    "href": "[OCEHost]/documents/api/1.2/folders/F6D00906682BEE445AE023D9A74012C07F07B9C4E3A0"
                },
                {
                    "rel": "parent",
                    "href": "[OCEHost]/documents/api/1.2/folders/F1564DFB2D7C7FBE8EE7A38CACF5DA9752E1734D9F36"
                },
                {
                    "rel": "child",
                    "href": "[OCEHost]/documents/api/1.2/folders/F6D00906682BEE445AE023D9A74012C07F07B9C4E3A0/items"
                }
            ]
        },
        {
            "id": "FAC441565BA56476111D864028751E0EF7ECCB1679CF",
            "type": "folder",
            "name": "sub folder 2",
            "description": "description for folder 2",
            "parentID": "F1564DFB2D7C7FBE8EE7A38CACF5DA9752E1734D9F36",
            "createdTime": "2021-03-15T22:13:43Z",
            "modifiedTime": "2021-03-15T22:13:43Z",
            "childItemsCount": "0",
            "childFolderCount": "0",
            "childFileCount": "0",
            "createdBy": {
                "displayName": "User AA",
                "id": "UCC2702CD5AED3F95DBB8FD8EBD09207B89C",
                "loginName": "userAALoginName",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "id": "UCC2702CD5AED3F95DBB8FD8EBD09207B89C",
                "loginName": "userAALoginName",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "id": "UCC2702CD5AED3F95DBB8FD8EBD09207B89C",
                "loginName": "userAALoginName",
                "type": "user"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "[OCEHost]/documents/api/1.2/folders/FAC441565BA56476111D864028751E0EF7ECCB1679CF"
                },
                {
                    "rel": "canonical",
                    "href": "[OCEHost]/documents/api/1.2/folders/FAC441565BA56476111D864028751E0EF7ECCB1679CF"
                },
                {
                    "rel": "parent",
                    "href": "[OCEHost]/documents/api/1.2/folders/F1564DFB2D7C7FBE8EE7A38CACF5DA9752E1734D9F36"
                },
                {
                    "rel": "child",
                    "href": "[OCEHost]/documents/api/1.2/folders/FAC441565BA56476111D864028751E0EF7ECCB1679CF/items"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "[OCEHost]/documents/api/1.2/folders/F1564DFB2D7C7FBE8EE7A38CACF5DA9752E1734D9F36/_bulkCreate?links=true"
        },
        {
            "rel": "canonical",
            "href": "[OCEHost]/documents/api/1.2/folders/F1564DFB2D7C7FBE8EE7A38CACF5DA9752E1734D9F36/_bulkCreate?links=true"
        },
        {
            "rel": "child",
            "href": "[OCEHost]/documents/api/1.2/folders/items"
        }
    ]
}

先頭に戻る