Overview
The Studio API is broken up into three categories: 1) Studio Sessions 2) Studio Projects and 3) Studio Project File Jobs (“Jobs” for short). The calls related to Studio Sessions and Studio Projects provide control and access to Sessions and Projects themselves, as well as their Users, Permissions, Files and unique functionality. The calls related to Studio Project File Jobs provide access to document processing functionality available within Studio Projects. Below you will find tables that list specific functionality within each category.
Additional Resources
- Visit the Example Workflows page to see how you might use the calls found in each of these categories.
- To learn more about Studio in general, visit our Bluebeam Studio page.
Studio Sessions
Category and Available Information | API Functions |
---|---|
Studio SessionsID, name, restricted status, expiration date, session end date, version, created date, invite URL, owner e-mail, status |
|
Session Permissions |
|
Session UsersID, name, e-mail, current user is owner?, status, restricted status, status message |
|
Session User Permissions |
|
Session FilesID, name, source, size, CRC, created date, download URL (null for collection) |
|
Session ActivityID, document ID, user ID, message, created date |
|
Studio Projects
Category and Available Information | API Functions |
---|---|
Studio ProjectsID, name, restricted status, created date, invite URL, owner e-mail |
|
Project Permissions |
|
Project UsersID, name, e-mail, current user is owner?, restricted status |
|
Project User Permissions |
|
Project FoldersID, name, path, parent folder ID, created date, permission setting |
|
Project Folder Permissions |
|
Project FilesID, name, path, parent folder ID, created date, permission setting, CRC, size, locked status, in a Session?, name of Session, Session ID, lock owner e-mail, lock owner name, download URL (null for collection), version number |
|
Project File RevisionsID, comment, CRC, operation type, revision available?, revision number, revision restorable?, size, timestamp, user e-mail, user name, version number, download URL (null for collection) |
|
Project Shared LinksID, sharing user ID, sharing user name, Project item ID, public Project ID, share link, filename, enabled?, hidden?, expired?, password protected?, click count, download count, last clicked date, last downloaded date, expiration date, created date |
|
Jobs
Category and Available Information | API Functions |
---|---|
Project File Jobs |
|