Available Actions in the Actions API |
BarTender REST API は、YAML や JSON 形式、または既存のレガシー BTXML スクリプトでさまざまな操作を実行するために使用できる REST エンドポイントを提供します。
BarTender REST API で使用できる操作は、BarTender Designer、Integration Builder、および Process Builder で実行できる操作とほとんど同じです。グラフィカルユーザーインターフェイスを使用して自動化を設定する場合は、上記のアプリケーションを使用できます。REST API を使用すると、さまざまな操作をプログラミングで実行できます。
BarTender REST API では、次の操作がサポートされています。
|
アクション |
説明 |
|---|---|
|
PrintBTWAction |
BarTender ドキュメントを印刷します。 |
|
PrintBTXMLScriptAction |
BTXML スクリプトを使用して BarTender ドキュメントを印刷します。 |
|
PrintCommandScriptAction |
コマンドラインとデータの組み合わせを使用して BarTender ドキュメントを印刷します。 |
|
アクション |
説明 |
|---|---|
|
BTXMLPrintResponseToIBMWebSphereAction |
実行された最後の BarTender コマンドから受信した BTXML スクリプト応答を IBM WebSphere Sensor Events に変換します。 |
|
IBMWebSphereToBTXMLAction |
受信する IBM WebSphere Sensor Events を BTXML スクリプトに変換します。 |
|
IBMWebSphereToBTXMLWithPrintStatusAction |
受信する IBM WebSphere Sensor Events を、印刷状態を含む BTXML スクリプトに変換します。 |
|
InsertAfterEndAction |
内容の末尾に特定のテキストまたは文字を挿入します。 |
|
InsertBeforeStartAction |
内容の先頭に特定のテキストまたは文字を挿入します。 |
|
OraclePrintRequestToBTXMLAction |
受信する Oracle XML 要求を BTXML スクリプトに変換します。 |
|
SAPAIIToBTXMLAction |
受信する SAP AII XML を BTXML スクリプトに変換します。 |
|
SearchAndDeleteAction |
内容の特定のテキストまたは文字を検索し、削除します。 |
|
SearchAndDeleteEverythingAfterAction |
内容の特定のテキストまたは文字を検索し、その後に続くすべての内容を削除します。 |
|
SearchAndDeleteEverythingBeforeAction |
内容の特定のテキストまたは文字を検索し、その前にあるすべての内容を削除します。 |
|
SearchAndInsertAfterAction |
内容の特定のテキストまたは文字を検索し、指定したテキストの後に挿入します。 |
|
SearchAndInsertBeforeAction |
内容の特定のテキストまたは文字を検索し、指定したテキストの前に挿入します。 |
|
SearchAndReplaceAction |
内容の特定のテキストまたは文字を検索し、指定したテキストに置き換えます。 |
|
TransformXMLUsingXSLTAction |
XSLT スタイルシートを使用することによってカスタムまたは独自の XML 形式を変換します。 |
|
アクション |
説明 |
|---|---|
|
ReadFileAction |
サポートされるファイルシステム (FTP、Web、クラウドストレージ) 上のファイルの内容を読み取ります。 |
|
ReadFromNetworkSocketAction |
受信データを TCP または UDP ソケットから読み取ります。 |
|
ReadFromSerialPortAction |
シリアルポートで受信データを読み取ります。 |
|
WaitForFileAction |
後続の操作を実行する前にファイルが指定のフォルダに表示されるまで待機します。 |
|
アクション |
説明 |
|---|---|
|
SendEmailAction |
電子メールメッセージを送信します。 |
|
SendToMessageQueueAction |
メッセージを Microsoft Message Queuing (MSMQ) サービスに送信します。 |
|
SendToNetworkSocketAction |
TCP または UDP ソケットを介してデータを送信します。 |
|
SendToSerialPortAction |
シリアルポートに情報を書き込みます。 |
|
SendWebServiceRequestAction |
Web サービス (REST または SOAP) に HTTP 要求を送信します。 |
|
WriteFileAction |
ファイルに内容を書き込みます。 |
|
WriteMessageToLogAction |
メッセージ ログに情報を送信します。 |
|
アクション |
説明 |
|---|---|
|
ActionGroup / GroupActions |
操作のグループを管理および実行します。 |
|
BarTenderCommandLineAction |
コマンドラインインターフェイスを使用して BarTender ドキュメントを印刷します。 |
|
BarTenderProcessAction |
BarTender Process Builder で作成されたプロセスファイルを実行します。 |
|
ConditionActions |
条件の結果 (true または false) に応じて操作を実行します。 |
|
DecrementVariableAction |
操作を実行するたびに指定した値で変数を減分します。 |
|
ForEachFileInArchiveActions |
指定したフィルタに一致するアーカイブフォルダ内のすべてのファイルに特定の操作 (または操作のグループ) を実行します。 |
|
ForEachFileInFolderActions |
指定したフィルタに一致するフォルダ内のすべてのファイルに特定の操作 (または操作のグループ) を実行します。 |
|
ForLoopActions |
変数を増分または減分することによって、指定したループに対して操作のグループを実行します。 |
|
GoToAction |
特定の操作にジャンプして処理を続行します。 |
|
IncrementVariableAction |
指定した値で変数を増分します。 |
|
PowerShellCommandAction |
Windows PowerShell コマンド (スクリプト) を実行します。 |
|
PrintBTWAction |
BarTender ドキュメントを印刷します。 |
|
PrintBTXMLScriptAction |
BTXML スクリプトを使用して BarTender ドキュメントを印刷します。 |
|
PrintCommandScriptAction |
コマンドラインとデータの組み合わせを使用して BarTender ドキュメントを印刷します。 |
|
RunAsUserActions |
指定した資格情報を使用して操作のグループを実行します。 |
|
SelectCaseAction |
指定した条件に従って、実行する Case サブ操作を評価します。 |
|
SetMultipleVariablesAction |
1 つ以上の変数の値を設定します。 |
|
SetVariableAction |
1 つの変数の値を設定します。 |
|
ShellCommandAction |
オペレーティングシステムコマンドまたはサードパーティユーティリティを実行するために使用できるシェルコマンドを実行します。 |
|
StopAction |
現在の統合のすべての操作を停止します。 |
|
WaitAction |
操作が終了するまで待機する時間を指定します。この操作を使用して、連続する操作を一時停止できます。 |
|
WaitForFileAction |
後続の操作を実行する前にファイルが指定のフォルダに表示されるまで待機します。 |
|
WhileLoopActions |
条件が満たされる限りグループ内の操作の実行を継続します。 |
|
WorkflowTransitionAction |
指定の遷移を使用して Librarian ファイルをワークフローの 1 つの状態から別の状態に移動します。 |
|
アクション |
説明 |
|---|---|
|
AddFilesToArchiveAction |
1 つ以上のファイルをフォルダからアーカイブに追加します。 |
|
CopyFileAction |
ファイルをある場所から他の場所にコピーします。 |
|
CopyFolderAction |
フォルダを別のフォルダの場所にコピーします。 |
|
CreateFolderAction |
フォルダーを作成します。 |
|
DeleteFileAction |
ファイルを削除します。 |
|
DeleteFolderAction |
フォルダーを削除します。 |
|
ExtractFilesFromArchiveAction |
アーカイブからファイルを指定のフォルダに抽出します。 |
|
ForEachFileInArchiveActions |
指定したフィルタに一致するアーカイブフォルダ内のすべてのファイルに特定の操作 (または操作のグループ) を実行します。 |
|
ForEachFileInFolderActions |
指定したフィルタに一致するフォルダ内のすべてのファイルに特定の操作 (または操作のグループ) を実行します。 |
|
MoveFileAction |
ファイルをある場所から他の場所に移動します。 |
|
MoveFolderAction |
フォルダをある場所から他の場所に移動します。 |
|
ReadFileAction |
サポートされるファイルシステム (FTP、Web、クラウドストレージ) 上のファイルの内容を読み取ります。 |
|
RenameFileAction |
ファイル名を変更します。 |
|
RenameFolderAction |
フォルダーの名前を変更します。 |
|
WriteFileAction |
ファイルに内容を書き込みます。 |
|
WorkflowTransitionAction |
指定の遷移を使用して Librarian ファイルをワークフローの 1 つの状態から別の状態に移動します。 |
|
アクション |
説明 |
|---|---|
|
DeleteDatabaseRecordAction |
接続されたデータベースから 1 つ以上のレコードを削除します。 |
|
ExecuteSQLAction |
SQL スクリプトを実行します。 |
|
ForEachDatabaseRecordActions |
データベースクエリの各レコードに対して操作を実行します。 |
|
InsertDatabaseRecordAction |
接続されたデータベースにデータベースレコードを挿入します。 |
|
TransformTextToRecordSetAction |
テキストまたはテキストファイルをレコードセットに変換します。 |
|
UpdateDatabaseRecordsAction |
データベースレコードを更新します。 |
|
|
To help you automate these actions by using the YAML file format, a YAML actions reference is provided as follows:
|