Storage

Files

Download API definition:

POST https://sampleHostName/storage/folders/{folderId}/files

Create new file

Notes

File creation is three steps operation. This request will create file's meta data. Next two requests need to be executed by using links from the response. Maximum file size to upload with single request is 256 MiB. If bigger file needs to be uploaded there are possibility to use Azure libraries to upload file via given Azure SAS url or by uploading file with multiple requests.

  • uploadUrl is required for file upload. Upload can be done by sending http request and specifying x-ms-blob-type header to BlockBlob.
  • completeUrl should be used to confirm file upload and it is final request for file creation.

Authentication

Requires Authorization header with valid Bearer token for scope storage:modify.

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 InvalidCreateFileRequest error with 422 status code. This could happen because of these reasons:

  • File name contains invalid characters.
  • File name's length is larger than 255 characters.
  • File could be harmful. For example, executable files are not accepted.

Request parameters

Name
In
Required?
Description
folderId
template
Yes

Folder Id

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope storage:modify

Accept
No

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

Request body

file-create

Name
Type
Required?
Description
No data.

Response 202 Accepted

Accepted

json

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

Response 404 Not Found

Parent folder cannot be found.

json

Response 422 Unprocessable Entity

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

json

Response 429 Too many requests

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

json

Response headers

Name
Description
retry-after

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