Search for folders and files in folder - Storage

REST API Overview

Reference

Changelog

Storage

Download API definition:

Search for folders and files in folder

GET https://dev-api.bentley.com/storage/folders/{folderId}/search?name[&$skip][&$top]

Search the files and folders in the Folder by name

The folderId and name MUST be provided in the parameters.

Parameters

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

name - name of the file or folder which you want to search inside the folder with folderId.

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

Request parameters

folderId

Yes

Id of the folder in which you want to search items

name

Yes

name of the file or folder which you want to search inside the folder with folderId

$skip

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

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

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 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 client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

links (paging)

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

self

link

URL for redoing the current request.

link

URL for getting the next page of results.

link

URL for getting the previous page of results.

links (item)

URLs for accessing users' details and parent folder.

createdBy

link

URL for getting user's details who created item.

lastModifiedBy

link

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

parentFolder

link

URL for getting the parent folder.

link

Hyperlink container.

href

String

Hyperlink to the specific entity.

item (typed)

String

Unique Identifier of the item.

type

String

Identification of the item entity.

displayName

String

Display name of the item.

description

String

Description of the item.

path

String

Absolute path to the item.

lastModifiedByDisplayName

String

Display name of the user who modified item last.

createdDateTime

Date-time

Date when the item was created.

lastModifiedDateTime

Date-time

Date when the item was last time modified.

parentFolderId

String

Unique Identifier of the parent folder.

_links

links-item

Contains the hyperlinks to users' details and parent folder.

items-response

List of folders and files.

items

item-details[]

List of folders and files.

_links

links-paging

Error

Contains error information.

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.

error

Error

Error information.

Was this page helpful?