Skip to navigation

WorkspaceItems Resource

View as Markdown

The WorkspaceItems resource provides methods that allow you to manage workspace items.

Methods supported

MethodDescription
createFIlePOST /restapi/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files
Creates a workspace file.
deleteFolderItemsDEL /restapi/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}
Deletes workspace one or more specific files/folders from the given folder or root.
getFileGET /restapi/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}
Get Workspace File
listFilePagesGET /restapi/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages
List File Pages
listFolderItemsGET /restapi/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}
List Workspace Folder Contents
updateFilePUT /restapi/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}
Update Workspace File Metadata

WorkspaceItems properties

PropertyTypeDescription
callerAuthorizationworkspaceUserAuthorization
contentTypestring
createdstringThe UTC DateTime when the workspace item was created.
createdByIdstring
createdByInformationworkspaceUserDetails about the user who created the workspace item.
extensionstring
fileSizestring
fileUristring
idstring
isPublicstringIf true, this supersedes need for bit mask permission with workspaceUserAuthorization
lastModifiedstring
lastModifiedByIdstringUtc date and time the comment was last updated (can only be done by creator)
lastModifiedByInformationworkspaceUserDetails about the user who last modified the workspace item.
namestringA simple string description of the item, such as a file name or a folder name.
pageCountstring
parentFolderIdstringThe ID of the parent folder. This is the GUID of the parent folder, or the special value ‘root’ for the root folder.
parentFolderUristring
typestringThe type of the workspace item. Valid values are file, folder.
uristring