uip api-workflow run

「uip api-workflow run」の構文とオプション - バンドルされたサーバーレス ワークフロー Executor を使用して、API ワークフローの JSON ファイルをローカルで実行します。

uip api-workflow run は、バンドルされているサーバーレス ワークフロー Executor を使用して、API ワークフローの JSON ファイルをローカルで実行します。入力引数は JSON として渡されます。既定では、Executor は uip login セッションから UiPath の資格情報を読み込むため、ワークフローはコネクタやクラウドで保護されたサービスに到達できます。[--no-authを渡す] を選択すると、資格情報の読み込みをスキップしてローカルのみのモードで実行することができます。

概要

uip api-workflow run <file> [options]

• <file> — ワークフローの JSON ファイルへのパスです。

オプション

フラグ	説明
-i, --input-arguments <json>	引数を JSON 文字列として入力します (例: '{"name": "World"}')。
--input-file <name=path>	ローカル ファイルをアップロードし、 ファイル (JobAttachment) の入力 <name>として渡します。複数のファイルに対して繰り返し可能です。サインイン セッションが必要です。
--output-dir <dir>	ワークフロー出力内のすべてのファイル (JobAttachment) 参照を <dir>にダウンロードします。ダウンロードされた各参照には、 LocalPathが付与されます。サインイン セッションが必要です。
--folder-key <guid>	この実行で作成される添付ファイルの Orchestrator フォルダー キーです ([ファイルから Base64]/[Base64 からファイルへ] アクティビティによってアップロードされた入力と書き込まれたファイル)。
--no-auth	資格情報の読み込みをスキップします。ワークフローはローカル専用モードで実行され、コネクタやクラウドでバックアップされたサービスにはアクセスできません ( --input-file/--output-dirも無効化されます)。

例

# Run with an inline input object
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}'

# Run without loading credentials (offline / local-only)
uip api-workflow run ./workflow.json --no-auth

# Extract just the output payload
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}' \
    --output-filter 'Data.Output'

# Upload a local file as a file (JobAttachment) input, and download any file
# outputs the workflow produces
uip api-workflow run ./workflow.json \
    --input-file document=./invoice.pdf \
    --output-dir ./out

データシェイプ(--output json)

{
  "Code": "WorkflowRun",
  "Data": {
    "Status": "Completed",
    "Output": {
      "greeting": "Hello, World!"
    }
  }
}

Status 、Executor の最終ステート (Completed、 Faultedなど) が反映されます。エラーが発生した実行は、標準の 終了コードに従って 0 以外で終了します。

ワークフローの出力にファイル (JobAttachment) の参照が含まれていて、 --output-dir が設定されている場合は、代わりにダウンロードしたファイルの中央に配置されます。

{
  "Code": "WorkflowRun",
  "Data": {
    "Encoded": {
      "Id": "6f1c0d2e-8a1b-4c3d-9e0f-123456789abc",
      "FullName": "invoice.base64",
      "MimeType": "text/plain",
      "LocalPath": "/abs/path/out/invoice.base64"
    }
  }
}

LocalPath は、 --output-dir が設定されている場合にのみ設定されます。設定されていない場合、参照はローカル ファイルなしで返されます。

関連

• uip api-workflow build — プロジェクトを実行する前にコンパイルします。
• uip api-workflow pack — 検証済みのワークフローをパッケージ化してパブリッシュします。

参照

• API ワークフロー ツールの概要
• グローバル オプション
• 終了コード
• uip login — --no-authが設定されていない限り、runによって読み込まれた資格情報。