• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Table of contents
    Overview
    Tutorials
    Samples
    Changelog
    Storage
    Download API definition:
    Create folder
    POST https://qa-api.bentley.com/storage/folders/{folderId}/folders

    Creates a Folder inside the provided FolderId.

    As shown in the request section below, you must provide a request body.

    The displayName MUST be provided in the request body, and the folderId MUST be provided in the parameters.

    Parameters

    folderId – Id of the folder in which you want to create the folder.

    Authentication

    Requires Authorization header with valid Bearer token for scope itwin-platform.

    For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

    Authorization

    User must be an Organization Administrator for the Organization that owns a given Project or have storage_write permission assigned at the Project level.

    An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

    Errors

    This request can return InvalidCreateFolderRequest error with 422 status code. This could happen because of these reasons:

    • Folder name contains invalid characters.
    • Folder name's length is larger than 255 characters.

    Request

    Request parameters

    Name
    Required?
    Description
    folderId
    Yes

    Id of the folder in which you want to create the folder.

    Request headers

    Name
    Required?
    Description
    Authorization
    Yes

    OAuth access token with itwin-platform scope

    Accept
    Yes

    Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

    Request body

    folder (create)

    Name
    Type
    Required?
    Description
    displayName
    String
    Yes

    Display name of the folder.

    description
    String
    No

    Description of the folder.

    Example

    json
    {
    "displayName": "test",
    "description": "test folder"
}

    Response

    Response 201 Created

    Created

    json
    {
    "folder": {
        "id": "TYJsPN0xtkWId0yUrXkS5pN5AQzuullIkxz5aDnDJSI",
        "displayName": "test",
        "description": "test folder",
        "path": "folderName/test",
        "lastModifiedByDisplayName": "Bob User",
        "createdDateTime": "2020-05-03T11:05:11.0133549Z",
        "lastModifiedDateTime": "2020-05-03T11:05:11.0133549Z",
        "parentFolderId": "TYJsPN0xtkWId0yUrXkS5g0CIYaGZLxEozrWBCOcS_s",
        "_links": {
            "createdBy": {
                "href": "https://api.bentley.com/accesscontrol/itwins/6959daff-27f5-4b87-96ea-9917daa3a8ff/members/1140f95b-1ba0-49d9-bbf4-b53e54d80387"
            },
            "lastModifiedBy": {
                "href": "https://api.bentley.com/accesscontrol/itwins/6959daff-27f5-4b87-96ea-9917daa3a8ff/members/1140f95b-1ba0-49d9-bbf4-b53e54d80387"
            },
            "parentFolder": {
                "href": "https://api.bentley.com/storage/folders/TYJsPN0xtkWId0yUrXkS5g0CIYaGZLxEozrWBCOcS_s"
            }
        }
    }
}

    Response 401 Unauthorized

    This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

    json
    {
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

    Response 404 Not Found

    Parent folder cannot be found.

    json
    {
    "error": {
        "code": "FolderNotFound",
        "message": "Requested folder is not available."
    }
}

    Response 422 Unprocessable Entity

    Invalid request to create a folder. Make sure that a valid folder ID and folder details were passed in.

    json
    {
    "error": {
        "code": "InvalidStorageRequest",
        "message": "The request to create folder was invalid. Please see the API Reference for possible reasons."
    }
}

    Response 429 Too many requests

    This response indicates that the user has sent too many requests in a given amount of time.

    json
    {
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

    Response headers

    Name
    Description
    retry-after

    The number of requests exceeds the rate-limit for the client subscription.

    Definitions

    folder (response)

    Retrieved folder response containing folder.

    Name
    Type
    Description
    folder
    folder-details

    Full representation of the folder.

    folder-details type

    Identification of the folder entity.

    Name
    Type
    Description
    folder
    String

    folder-details

    Full representation of the folder.

    Name
    Type
    Description
    folder-details type
    folder-details-type

    Identification of the folder entity.

    folder (create)

    Model for folder creation.

    Name
    Type
    Description
    displayName
    String

    Display name of the folder.

    description
    String

    Description of the folder.

    Error

    Contains error information.

    Name
    Type
    Description
    code
    String

    One of a server-defined set of error codes.

    message
    String

    A human-readable representation of the error.

    target
    String, null

    The target of the error.

    Error Response

    Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

    Name
    Type
    Description
    error
    Error

    Error information.