Available Actions in the Actions API

The BarTender REST API provides REST endpoints that you can use to run a variety of actions in YAML or JSON format or in an existing legacy BTXML script.

The actions that are available in the BarTender REST API are mostly the same as the actions that you can run in BarTender Designer, Integration Builder, and Process Builder. If you prefer to configure automation by using a graphical user interface, you can use those applications. By using the REST API, however, you can run these actions programmatically.

Action	Description
PrintBTWAction	Prints a BarTender document.
PrintBTXMLScriptAction	Prints one or more BarTender documents by using BTXML script.
PrintCommandScriptAction	Prints a BarTender document by using a combination of command lines and data.

Transform Actions

Action	Description
BTXMLPrintResponseToIBMWebSphereAction	Transforms the BTXML script response that was received from the last BarTender command that was run to IBM WebSphere Sensor Events.
IBMWebSphereToBTXMLAction	Transforms incoming IBM WebSphere Sensor Events to BTXML script.
IBMWebSphereToBTXMLWithPrintStatusAction	Transforms incoming IBM WebSphere Sensor Events to BTXML script that contains the print status.
InsertAfterEndAction	Inserts specific text or characters at the end of the contents.
InsertBeforeStartAction	Inserts specific text or characters before the contents starts.
OraclePrintRequestToBTXMLAction	Transforms an incoming Oracle XML request to BTXML script.
SAPAIIToBTXMLAction	Transforms the incoming SAP AII XML to BTXML script.
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.

Action	Description
ReadFileAction	Reads the content of a file on any supported file system, including FTP, web, and cloud storage.
ReadFromNetworkSocketAction	Reads from a TCP or UDP socket for incoming data.
ReadFromSerialPortAction	Reads from a serial port for incoming data.
WaitForFileAction	Waits for a file to appear in a specified folder before running subsequent actions.

Output Actions

Action	Description
SendEmailAction	Sends an email message.
SendToMessageQueueAction	Sends a message to the Microsoft Message Queuing (MSMQ) service.
SendToNetworkSocketAction	Sends data over a TCP or UDP socket.
SendToSerialPortAction	Writes information to a serial port.
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.
BarTenderCommandLineAction	Prints a BarTender document by using the command-line interface.
BarTenderProcessAction	Runs a process file that was created in BarTender Process Builder.
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.
PowerShellCommandAction	Runs a Windows PowerShell command (script).
PrintBTWAction	Prints a BarTender document.
PrintBTXMLScriptAction	Prints one or more BarTender documents by using BTXML script.
PrintCommandScriptAction	Prints a BarTender document by using a combination of command lines and data.
RunAsUserActions	Runs a group of actions by using the credentials that are specified.
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.
ShellCommandAction	Runs a shell command that can be used to run operating system commands or third-party utilities.
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.
WaitForFileAction	Waits for a file to appear in a specified folder before running subsequent actions.
WhileLoopActions	Continues to run the actions in the group as long as the condition is satisfied.
WorkflowTransitionAction	Moves a Librarian file from one state to another in its workflow by using the specified transition.

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, including FTP, web, and cloud storage.
RenameFileAction	Renames a file.
RenameFolderAction	Renames a folder.
WriteFileAction	Writes content to a file.
WorkflowTransitionAction	Moves a Librarian file from one state to another in its workflow by using the specified transition.

Action	Description
DeleteDatabaseRecordAction	Deletes one or more records from a connected database.
ExecuteSQLAction	Runs an SQL script.
ForEachDatabaseRecordActions	Runs actions for each record in a database query.
InsertDatabaseRecordAction	Inserts a database record into a connected database.
TransformTextToRecordSetAction	Transforms text or a text file to a record set.
UpdateDatabaseRecordsAction	Updates one or more database records.

Available Actions in the Actions API

Print Actions

Transform Actions

Input Actions

Output Actions

Execute Actions

File Actions

Database Actions