Table of contents
Storage
Download API definition:
GET https://api.bentley.com/storage/folders/{folderId}/search?name[&$skip][&$top]

Finds files and folders in folder by name

Notes

This query supports wildcard characters in the name parameter

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_read 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.

Request parameters

Name
Required?
Description
folderId
Yes

Folder Id

name
Yes

Item name

$skip
No

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$top
No

The $top system query option requests the number of items in the queried collection to be included in the result.

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.

Response 200 OK

OK

json
{
    "items": [{
            "type": "folder",
            "id": "TYJsPN0xtkWId0yUrXkS5pN5AQzuullIkxz5aDnDJSI",
            "displayName": "test",
            "description": "test folder/test",
            "path": "folderName/",
            "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"
                }
            }
        },
        {
            "type": "file",
            "id": "TYJsPN0xtkWId0yUrXkS5adTiHezskHPazRaHzjaBzd",
            "displayName": "test3.txt",
            "description": "test file 3",
            "path": "folderName/folderName2/test3.txt",
            "size": 1,
            "lastModifiedByDisplayName": "Bob User",
            "createdDateTime": "2020-05-03T11:05:12.0133549Z",
            "lastModifiedDateTime": "2020-05-03T11:05:12.0133549Z",
            "parentFolderId": "TYJsPN0xtkWId0yUrXkS5b1DUGcZLLeJfkqBVUAsaYj",
            "_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"
                }
            }
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/storage/folders/TYJsPN0xtkWId0yUrXkS5g0CIYaGZLxEozrWBCOcS_s/search?name=search-string&$skip=4&$top=2"
        },
        "prev": {
            "href": "https://api.bentley.com/storage/folders/TYJsPN0xtkWId0yUrXkS5g0CIYaGZLxEozrWBCOcS_s/search?name=search-string&$skip=2&$top=2"
        },
        "next": {
            "href": "https://api.bentley.com/storage/folders/TYJsPN0xtkWId0yUrXkS5g0CIYaGZLxEozrWBCOcS_s/search?name=search-string&$skip=6&$top=2"
        }
    }
}

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

Folder cannot be found.

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

Response 422 Unprocessable Entity

Invalid request to search for folders and files

json
{
    "error": {
        "code": "InvalidStorageRequest",
        "message": "Page size is over 1000 items limit."
    }
}

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.

links (paging)

URLs for redoing the current request, getting to the previous or next page of results, if applicable containg.

Name
Type
Description
self

URL for redoing the current request.

next

URL for getting the next page of results.

prev

URL for getting the previous page of results.

links (item)

URLs for accessing users' details and parent folder.

Name
Type
Description
createdBy

URL for getting user's details who created item.

lastModifiedBy

URL for getting user's details who last modified item.

parentFolder

URL for getting the parent folder.

link

Hyperlink container.

Name
Type
Description
href
String

Hyperlink to the specific entity.

folder (typed) type

Identification of the folder entity.

Name
Type
Description
folder
String

folder (typed)

Full representation of the folder with folder type.

Name
Type
Description
id
String

Unique Identifier of the folder.

folder (typed) type

Identification of the folder entity.

displayName
String

Display name of the folder.

description
String

Description of the folder.

path
String

Absolute path to the folder.

lastModifiedByDisplayName
String

Display name of the user who modified folder last.

createdDateTime
Date-time

Date when the folder was created.

lastModifiedDateTime
Date-time

Date when the folder was last time modified.

parentFolderId
String

Unique Identifier of the parent folder.

_links

Contains the hyperlinks to users' details and parent folder.

file (typed) type

Identification of the file entity.

Name
Type
Description
file
String

file (typed)

Name
Type
Description
id
String

Unique Identifier of the file.

file (typed) type

Identification of the file entity.

displayName
String

Display name of the file.

description
String

Description of the file.

path
String

Absolute path to the file.

size
Integer

Size to the file in bytes.

lastModifiedByDisplayName
String

Display name of the user who modified file last.

createdDateTime
Date-time

Date when the file was created.

lastModifiedDateTime
Date-time

Date when the file was last time modified.

parentFolderId
String

Unique Identifier of the parent folder.

_links

Contains the hyperlinks to users' details and parent folder.

items

List of folders and files.

Name
Type
Description

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 information.