DocuSign Momentum 2018DocuSign Momentum 2018

CloudStorage: listFolders

Retrieves a list of all the items in a specified folder from the specified cloud storage provider.

Request

HTTP request

GET /v2/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

serviceIdstring

The ID of the service to access.

Valid values are the service name ("Box") or the numerical serviceId ("4136").

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Optional Query Parameters
cloud_storage_folder_pathstring

A comma separated list of folder IDs included in the request.

countstring

An optional value that sets how many items are included in the response.

The default setting for this is 25.

orderstring

An optional value that sets the direction order used to sort the item list.

Valid values are:

  • asc = ascending sort order
  • desc = descending sort order

order_bystring

An optional value that sets the file attribute used to sort the item list.

Valid values are:

  • modified
  • name

search_textstring

start_positionstring

Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.

Responses

CodeDescriptionReference
200

Successful response.

CloudStorage
400

Error encountered.

errorDetails

SDK Method

CloudStorage::listFolders

Definitions

errorDetails
externalDocServiceErrorDetails
externalFile
CloudStorage

Examples

Generic JSON Response
Generic XML Response