Get files in folder - Storage

Storage

Download API definition:

Get files in folder

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

Get the files in folder with folderId.

The folderId MUST be provided in the parameters.

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.

$top

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

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

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

{
    "files": [{
        "id": "TYJsPN0xtkWId0yUrXkS5pN5AQzuullIkxz5aDnDJSI",
        "displayName": "test.txt",
        "description": "test file",
        "path": "folderName/test.txt",
        "size": 1,
        "lastModifiedByDisplayName": "Bob User",
        "createdDateTime": "2020-05-03T11:05:11.0133549+00:00",
        "lastModifiedDateTime": "2020-05-03T11:05:11.0133549+00:00",
        "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"
            }
        }
    }, {
        "id": "TYJsPN0xtkWId0yUrXkS5s4FlCroosBMlyDhZZmlzoc",
        "displayName": "test2.txt",
        "description": "test file 2",
        "path": "folderName/test2.txt",
        "size": 1,
        "lastModifiedByDisplayName": "Bob User",
        "createdDateTime": "2020-05-03T11:05:12.0133549+00:00",
        "lastModifiedDateTime": "2020-05-03T11:05:12.0133549+00:00",
        "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"
            }
        }
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/storage/folders/TYJsPN0xtkWId0yUrXkS5g0CIYaGZLxEozrWBCOcS_s/files?$skip=4&$top=2"
        },
        "prev": {
            "href": "https://api.bentley.com/storage/folders/TYJsPN0xtkWId0yUrXkS5g0CIYaGZLxEozrWBCOcS_s/files?$skip=2&$top=2"
        },
        "next": {
            "href": "https://api.bentley.com/storage/folders/TYJsPN0xtkWId0yUrXkS5g0CIYaGZLxEozrWBCOcS_s/files?$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 get files in folder

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

link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "description": "Hyperlink container.",
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

file-details type

Identification of the file entity.

file

String

json

{
    "enum": [
        "file"
    ],
    "type": "string",
    "description": "Identification of the file entity.",
    "title": "file-details type"
}

file-details

size

Integer

Size to the file in bytes.

file-details type

file-details-type

Identification of the file entity.

isFileLocked

Boolean, null

Indicate whether the file is locked or not.

json

{
    "type": "object",
    "allOf": [
        {
            "$ref": "#/components/schemas/item-details"
        }
    ],
    "properties": {
        "size": {
            "type": "integer",
            "description": "Size to the file in bytes."
        },
        "type": {
            "enum": [
                "file"
            ],
            "type": "string",
            "description": "Identification of the file entity.",
            "title": "file-details type",
            "$ref": "#/components/schemas/file-details-type"
        },
        "isFileLocked": {
            "type": "boolean",
            "nullable": true,
            "description": "Indicate whether the file is locked or not."
        }
    }
}

links (paging)

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

link

self

link

json

{
    "type": "object",
    "title": "links (paging)",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/link"
        },
        "prev": {
            "$ref": "#/components/schemas/link"
        },
        "self": {
            "$ref": "#/components/schemas/link"
        }
    },
    "description": "URLs for redoing the current request, getting to the previous or next page of results, if applicable containg.",
    "additionalProperties": false
}

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.

json

{
    "type": "object",
    "title": "Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "description": "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.",
    "additionalProperties": false
}

files-details-response

List of files.

files

file-details[]

_links

links-paging

json

{
    "type": "object",
    "properties": {
        "files": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/file-details"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/links-paging"
        }
    },
    "description": "List of files.",
    "additionalProperties": false
}

Was this page helpful?