Available Actions in the Actions API

The actions that are available in the Actions API include many of the same actions that you can run in BarTender Designer, Integration Builder, and Process Builder. By using the Actions API REST endpoints, you can run these actions in YAML or JSON format, or in an existing legacy BTXML script.

A YAML reference document is available that provides complete details about the specific properties for each action and describes how to combine actions into groups and create arrays of actions to be sent as one script to the server. The YAML actions reference is provided as follows:

Online at https://help.seagullscientific.com/BarTenderCloud/Actions_YAML_reference/

The Actions API supports the following actions.

Print Actions

Action	Description
PrintBTWAction	Prints a BarTender document.
PrintPDFAction	Prints a PDF document by using the BTXML script.
PrintBTXMLScriptAction	Prints one or more BarTender documents by using BTXML script.

Transform Actions

Action	Description
InsertAfterEndAction	Inserts specific text or characters at the end of the contents.
InsertBeforeStartAction	Inserts specific text or characters before the contents starts.
SearchAndDeleteAction	Searches for specific text or characters in the contents and deletes it.
SearchAndDeleteEverythingAfterAction	Searches for specific text or characters in the contents and deletes everything after it.
SearchAndDeleteEverythingBeforeAction	Searches for specific text or characters in the contents and deletes everything before it.
SearchAndInsertAfterAction	Searches for specific text or characters in the contents and inserts it after the specified text.
SearchAndInsertBeforeAction	Searches for specific text or characters in the contents and inserts it before the specified text.
SearchAndReplaceAction	Searches for specific text or characters in the contents and replaces it with the specified text.
TransformXMLUsingXSLTAction	Transforms a custom or proprietary XML format by using an XSLT stylesheet.

Input Actions

Action	Description
ReadFileAction	Reads the content of a file on any supported file system.

Output Actions

Action	Description
SendEmailAction	Sends an email message.
SendWebServiceRequestAction	Sends an HTTP request to a web service (REST or SOAP).
WriteFileAction	Writes content to a file.
WriteMessageToLogAction	Sends information to the message log.

Execute Actions

Action	Description
ActionGroup / GroupActions	Manages and runs a group of actions.
ConditionActions	Runs actions either for true or false based on the result of the condition.
DecrementVariableAction	Decrements the variable by a specified value each time the action is run.
ForEachFileInArchiveActions	Runs a group of one or more actions for all files in an archive folder that match a specified filter.
ForEachFileInFolderActions	Runs a group of one or more actions for all files in a folder that match a specified filter.
ForLoopActions	Runs the actions in the group for the specified loop by incrementing or decrementing the variable.
GoToAction	Jumps to a specific action to continue processing.
IncrementVariableAction	Increments the variable by a specified value.
PrintBTWAction	Prints a BarTender document.
PrintBTXMLScriptAction	Prints one or more BarTender documents by using BTXML script.
SelectCaseAction	Evaluates which Case sub-actions to run, according to their specified conditions.
SetMultipleVariablesAction	Sets the value of one or more variables.
SetVariableAction	Sets the value of one variable.
StopAction	Stops all actions in the current integration.
WaitAction	Specifies a time period that elapses before the action finishes. You can use this action to create a pause in sequential actions.
WhileLoopActions	Continues to run the actions in the group as long as the condition is satisfied.

File Actions

Action	Description
AddFilesToArchiveAction	Adds one or more files from a folder to an archive.
CopyFileAction	Copies one or more files from one location to another.
CopyFolderAction	Copies a folder to another folder location.
CreateFolderAction	Creates a folder.
DeleteFileAction	Deletes one or more files.
DeleteFolderAction	Deletes a folder.
ExtractFilesFromArchiveAction	Extracts one or more files from an archive to a specified folder.
ForEachFileInArchiveActions	Runs a group of one or more actions for all files in an archive folder that match a specified filter.
ForEachFileInFolderActions	Runs a group of one or more actions for all files in a folder that match a specified filter.
MoveFileAction	Moves one or more files from one location to another.
MoveFolderAction	Moves a folder from one location to another.
ReadFileAction	Reads the content of a file on any supported file system.
RenameFileAction	Renames a file.
RenameFolderAction	Renames a folder.
WriteFileAction	Writes content to a file.

Print Control Actions

Action	Description
Cancel Print Job	Cancel the specified print job.
Cancel Print Job Queue	Cancel and remove all print jobs associated with the specified printer
Get All Print Queues	Retrieve the status of the all print queues.
Get Print Job Status	Retrieve the status of a specific print job.
Get Print Queue	Retrieve information about the print queue and all print jobs associated with the specified printer.
Hold Print Job	Hold the specified print job.
Pause Print Queue	Pause all print jobs associated with the specified printer.
Release Print Job	Release the specified print job.
Resume Print Queue	Resume all print jobs associated with the specified printer.

Permissions

All users are required to have the global permission API User when executing an API request to the Actions API. The Print Control Action API requires additional permissions. These permissions govern who can access the Print Control Action API and what actions they can perform using the API. These permissions are divided into two broad categories: users with Administrator permissions and users without Administrator permissions.

Administrators: These users have unrestricted access to all queue functionality and full control over all print queue and print job actions.
Non-Administrators: Access given to these users is determined by the combined assigned global and printer resource permissions.

Non-Admin User Permission Combinations

Action	Global Permissions		Printer Resource Permissions
Cancel Print Job	Cancel Own Job: Print Access or Manage Printer	Cancel Any Job: Manage Printer	Cancel Own Job: Print	Cancel Any Job: Manage Printer
Cancel Print Job Queue	Manage Printer		Manage Printer
Get All Print Queues	Print Access or View History or Manage Printers		Print or View Job History or Manage Printer
Get Print Job Status	Print Access or View History or Manage Printers		Print or Manage Printer or View History
Get Print Queue	Print Access or View History or Manage Printers		Print or View Job History or Manage Printer
Hold Print Job	Pause/Hold Own Job: Print Access or Manage Printer	Pause/Hold Any Job: Manage Printer	Pause/Hold Own Job: Print	Pause/Hold Any Job: Manage Printer
Pause Print Queue	Manage Printer		Manage Printer
Release Print Job	Resume/Release Own Job: Print Access or Manage Printer	Resume/Release Any Job: Manage Printer	Resume/Release Own Job: Print	Resume/Release Any Job: Manage Printer
Resume Print Queue	Manage Printer		Manage Printer

When a user does not have permission to view certain jobs, those jobs are still included in the response to preserve queue integrity and ordering. However, only limited, non-sensitive information is returned; all other fields are presented as null or empty values.