Studio API Functionality

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 Sessions

ID, name, restricted status, expiration date, session end date, version, created date, invite URL, owner e-mail, status

  • Get a list of all Sessions, including information about each
  • Get information about a specific Session
  • Create a new Session
  • Delete a Session
  • Update the Session name, restricted status, end date, owner, whether notifications are being sent and overall Session status

Session Permissions

  • Get the permission statuses for everyone in a Session
  • Update the Session’s global permission statuses to allow or deny users the ability to:
    • Save a copy of Session files
    • Print Session files
    • Markup documents in Session
    • Add documents to Session
    • Exercise full control over the Session
    • Send markup alerts

Session Users

ID, name, e-mail, current user is owner?, status, restricted status, status message

  • Get a list of all users participating in a Session, including information about each
  • Get information about a specific user participating in a Session
  • Add a current Studio user to a Session
  • Remove a user from a Session
  • Allow or deny a user access to a Project
  • Send an e-mail invitation to join a Session and, for those who are not current Studio users, a link to create a Studio account

Session User Permissions

  • Get the permission statuses of a specific user for a Session
  • Update Session users permission statuses to allow or deny them the ability to:
    • Save a copy of Session files
    • Print Session files
    • Markup documents in a Session
    • Add documents to Session
    • Exercise full control over a Session
    • Send markup alerts

Session Files

ID, name, source, size, CRC, created date, download URL (null for collection)

  • Get a list of all files in a Session, including information about each
  • Get information about a single file in a Session, including a download URL for the file
  • Upload a file to a Session
  • Get a snapshot of marked documents from a Session
  • Delete a Session file
  • Check a Session file back into the Project from which it was checked out

Session Activity

ID, document ID, user ID, message, created date

  • Get a list of all activity records logged for a Session, including information about each
  • Get information about a single Session activity record
  • Add a chat message to a Session record log

Studio Projects

Category and Available Information API Functions

Studio Projects

ID, name, restricted status, created date, invite URL, owner e-mail

  • Get the permission statuses for everyone in a Project
  • Update the Project’s global permission statuses to allow or deny users the ability to:
    • Create new Project
    • Delete a Project
    • Update the Project name, restricted status, owner, and whether notifications are being sent

Project Permissions

  • Get the global permission statuses for a Project to see what attendees are and are not allowed to do by default.
  • Update the Project’s global permission statuses to allow or deny users the ability to:
    • Create Sessions from Project files
    • Undo Checkouts to Project files
    • Invite users to Project
    • Manage Participants in Project
    • Manage overall Project Permissions
    • Exercise full control over the Project
    • Share Project Items

Project Users

ID, name, e-mail, current user is owner?, restricted status

  • Get a list of all users participating in a Project, including information about each
  • Get information about a specific user participating in a Project
  • Add a current Studio user to a Project
  • Remove a user from a Project
  • Allow or deny a user access to a Project
  • Send an e-mail invitation to join a Project and, for those who are not current Studio users, a link to create a Studio account

Project User Permissions

  • Get the permission statuses of a specific user for a Project to see what they are and are not allowed to do
  • Update the Project user’s permission statuses to allow or deny them the ability to:
    • Create Sessions from Project files
    • Undo Checkouts to Project files
    • Invite users to Project
    • Manage Participants in Project
    • Manage overall Project Permissions
    • Exercise full control over the Project
    • Share Project Items

Project Folders

ID, name, path, parent folder ID, created date, permission setting

  • Get a recursive list of all folders in a Project, including information about each
  • Get information about a single folder in a Project
  • Create a new folder in a Project
  • Delete a folder and all its contents from a Project
  • Move or rename a Project folder
  • Get a non-recursive list of all items contained within a Project folder, including information about each

Project Folder Permissions

  • Get the permission setting (Hidden, Read, ReadWrite, or ReadWriteDelete) for all users or a single user
  • Update the permission setting for a Project folder (Hidden, Read, ReadWrite, or ReadWriteDelete) for all users or a single user

Project Files

ID, 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

  • Get a list of all files in a Project, including information about each
  • Get information about a single file in a Project, including a download URL for the file
  • Upload a file to a Project
  • Delete a Project file
  • Move or rename a Project file
  • Create a copy of a file in a Project, specifying a destination folder and file name
  • Check out a Project file
  • Undo the checkout of an unmodified Project file
  • Check in a Project file that the user has checked out
  • Check a Project file out to an existing Session

Project File Revisions

ID, comment, CRC, operation type, revision available?, revision number, revision restorable?, size, timestamp, user e-mail, user name, version number, download URL (null for collection)

  • Get a list of all revisions to a Project file, including information about each
  • Get information about any particular revision of a Project file, including a download URL for the file
  • Restore a previous revision of a Project file

Project Shared Links

ID, 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

  • Get a list of all shared links in a Project, including information about each
  • Get information about a single shared link in a Project
  • Create a shared link for a Project file
  • Delete a shared link to a Project file
  • Update the disabled or hidden status of a shared link to a Project file

Jobs

Category and Available Information API Functions

Project File Jobs

  • Convert Word, Excel, PS, image and DWG (beta) files in a Project to PDF
  • Modify a PDF Project file in any of the following ways:
    • Add a Stamp
    • Add a header and footer
    • Balance pages
    • Combine files
    • Create PDF-A report
    • Delete pages
    • Export custom columns
    • Export form data
    • Export markups
    • Extract pages
    • Flatten
    • Get a file property value
    • Get a single file property
    • Get all file properties
    • Get the markup list
    • Get the page count
    • Get the page rotation
    • Get the page size
    • Import custom columns
    • Import markups
    • Insert blank pages
    • Insert pages
    • Process colors
    • Reduce file size
    • Repair
    • Replace pages
    • Reverse pages
    • Rotate pages
    • Save as PDF-A
    • Set PDF security
    • Set the open password
    • Split pages
    • Unflatten

Studio API Functionality

Studio Sessions

Studio Projects

Jobs

Was this article helpful?