WorkspaceItems: listFilePages

Retrieves a workspace file as rasterized pages.

Request

HTTP request

GET /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

fileIdstring

Specifies the room file ID GUID.

folderIdstring

The ID of the folder being accessed.

workspaceIdstring

Specifies the workspace ID GUID.

Optional Query Parameters
countstring

The maximum number of results to be returned by this request.

dpistring

Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.

max_heightstring

Sets the maximum height (in pixels) of the returned image.

max_widthstring

Sets the maximum width (in pixels) of the returned image.

start_positionstring

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Responses

CodeDescriptionReference
200

Successful response.

pageImages
400

Error encountered.

errorDetails

SDK Method

Workspaces::listWorkspaceFilePages

Definitions

errorDetails
page
pageImages

Examples

Generic JSON Response
Generic XML Response