Workato CLIコマンドリファレンス ​

WorkatoプラットフォームCLIツールのコマンドリファレンス。

workato ​

WorkatoプラットフォームCLIのルートコマンド。 Workatoのすべての自動化および統合管理機能にアクセスできます。

利用状況 ​

workato [GLOBAL_OPTIONS] <COMMAND> [COMMAND_OPTIONS]

オプション ​

結果 ​

引数なしで実行すると、使用可能なコマンドとグローバルオプションを表示します。

例 ​

workato --help

workato --profile production recipes list

workato init ​

新しいプロジェクト用にWorkato CLIを初期化します。 認証を設定し、リージョンを選択し、プロジェクトワークスペースを設定します。

利用状況 ​

workato init [OPTIONS]

オプション ​

結果 ​

設定ファイルを作成し、Workato APIで認証し、プロジェクト構造を設定します。

例 ​

workato init

workato init --profile prod --region eu --api-token wrkprod-xxx --project-name 'Production Integration'

workato workspace ​

アクティブなプロファイル、プロジェクト、コネクションステータスを含む現在のワークスペース情報を表示します。

利用状況 ​

workato workspace

結果 ​

現在のプロファイル、プロジェクトの詳細、APIエンドポイント、認証ステータスを表示します。

例 ​

workato workspace

workato pull ​

最新のアセットをWorkatoワークスペースからローカルプロジェクトディレクトリにプルします。 レシピ、コネクション、Data tablesを同期します。

利用状況 ​

workato pull [OPTIONS]

オプション ​

結果 ​

Workatoワークスペースから最新バージョンをダウンロードし、ローカルファイルを更新します。

例 ​

workato pull

workato pull --force

workato push ​

ローカル変更をWorkatoワークスペースにプッシュします。 変更されたレシピ、コネクション、その他のアセットをアップロードします。

利用状況 ​

workato push [OPTIONS]

オプション ​

結果 ​

ローカル変更をWorkatoワークスペースにアップロードし、必要に応じてレシピを再起動します。

例 ​

workato push

workato push --force --restart-recipes

workato profiles list ​

設定済みのすべての認証プロファイルを、リージョンおよびステータスとともに一覧表示します。

利用状況 ​

workato profiles list

結果 ​

名前、リージョン、APIエンドポイント、アクティブステータスを示すプロファイルのテーブルを表示します。

例 ​

workato profiles list

workato profiles use ​

以降のコマンドで使用する認証プロファイルを別のものに切り替えます。

利用状況 ​

workato profiles use <PROFILE_NAME>

入力 ​

結果 ​

指定したプロファイルを今後のCLI操作でアクティブに設定します。

例 ​

workato profiles use production

workato profiles status ​

現在アクティブなプロファイルとその設定詳細を表示します。

利用状況 ​

workato profiles status

オプション ​

結果 ​

アクティブなプロファイルの名前、関連付けられたワークスペース、コネクションステータスを表示します。

例 ​

workato profiles status

workato profiles status --verbose

workato profiles status --json

workato profiles delete ​

CLI設定からプロファイルを削除します。

利用状況 ​

workato profiles delete <PROFILE_NAME>

入力 ​

結果 ​

指定したプロファイルと関連設定を削除します。

例 ​

workato profiles delete development

workato projects list ​

現在のWorkatoワークスペースで使用可能なすべてのプロジェクトを一覧表示します。

利用状況 ​

workato projects list

結果 ​

ID、名前、説明、フォルダ数を含むプロジェクトのテーブルを表示します。

例 ​

workato projects list

workato projects use ​

CLI操作のプロジェクトコンテキストを別のものに切り替えます。

利用状況 ​

workato projects use <PROJECT_NAME>

入力 ​

結果 ​

アクティブなプロジェクトコンテキストを変更し、ローカルワークスペースを更新します。

例 ​

workato projects use 'Customer Integration'

workato recipes list ​

フィルタリングとページネーションオプションを使用して、ワークスペース内のレシピを一覧表示します。

利用状況 ​

workato recipes list [OPTIONS]

オプション ​

結果 ​

ID、名前、ステータス、フォルダ、最終アクティビティを含むレシピのテーブルを表示します。

例 ​

workato recipes list

workato recipes list --folder-id 123 --running

workato recipes list --adapter-names-any salesforce

workato recipes validate ​

Workatoスキーマ要件に対してレシピJSONファイルの構文と構造を検証します。

利用状況 ​

workato recipes validate --path <FILE_PATH>

オプション ​

結果 ​

構文エラー、不足しているフィールド、スキーマ違反を含む検証結果を報告します。

例 ​

workato recipes validate --path ./my_recipe.recipe.json

workato recipes start ​

停止中のレシピをIDまたは名前で開始し、トリガーを処理してアクションを実行できるようにします。

利用状況 ​

workato recipes start [OPTIONS]

オプション ​

結果 ​

指定したレシピを開始し、新しい実行ステータスを報告します。

例 ​

workato recipes start --id 12345

workato recipes start --name 'Daily Sales Report'

workato recipes stop ​

実行中のレシピを停止し、現在のジョブを完了しながら新しいトリガーの処理を防ぎます。

利用状況 ​

workato recipes stop [OPTIONS]

オプション ​

結果 ​

指定したレシピを停止し、新しい停止ステータスを報告します。

例 ​

workato recipes stop --id 12345

workato recipes stop --name 'Data Sync' --folder-id 456

workato recipes update-connection ​

停止中のレシピで特定のコネクターが使用するコネクションを更新します。

利用状況 ​

workato recipes update-connection RECIPE_ID [OPTIONS]

入力 ​

オプション ​

結果 ​

指定したアダプターのレシピのコネクションが、新しいコネクションを使用するように更新されます。 この操作を実行する前に、レシピを停止する必要があります。

例 ​

workato recipes update-connection 12345 --adapter-name salesforce --connection-id 67890

workato recipes update-connection 54321 -a slack -c 98765

workato connections list ​

プロバイダー、フォルダ、外部IDのフィルタリングオプションを使用して、ワークスペース内のすべてのコネクションを一覧表示します。

利用状況 ​

workato connections list [OPTIONS]

オプション ​

結果 ​

ID、名前、プロバイダー、ステータス、フォルダ情報を含むコネクションのテーブルを表示します。

例 ​

workato connections list

workato connections list --provider salesforce

workato connections list --folder-id 789

workato connections create ​

認証の詳細を使用して、特定のアプリケーションプロバイダーの新しいコネクションを作成します。

利用状況 ​

workato connections create [OPTIONS]

オプション ​

結果 ​

新しいコネクションを作成し、コネクションIDと認証ステータスを返します。

例 ​

workato connections create --name 'Prod SF' --provider salesforce

workato connections create --name 'JIRA Prod' --provider jira --input '{"server_url":"https://company.atlassian.net"}'

workato connections create-oauth ​

ユーザー認証フロー用にブラウザーを開いて、OAuthベースのコネクションを作成します。

利用状況 ​

workato connections create-oauth [OPTIONS]

オプション ​

結果 ​

OAuthフロー用にブラウザーを開き、完了時に認証済みコネクションを作成します。

例 ​

workato connections create-oauth --name 'Google Drive OAuth' --provider google_drive

workato connections get-oauth-url ​

新しいコネクションを確立するためのOAuth認可URLを生成します。

利用状況 ​

workato connections get-oauth-url CONNECTION_ID [OPTIONS]

入力 ​

オプション ​

結果 ​

ユーザーが権限を付与してコネクションを認証するためにアクセスする必要があるOAuth認可URLを返します。

例 ​

workato connections get-oauth-url 12345

workato connections get-oauth-url 12345 --redirect-url https://example.com/callback

workato connections update ​

名前や設定パラメーターなど、既存のコネクションプロパティを更新します。

利用状況 ​

workato connections update [OPTIONS]

オプション ​

結果 ​

コネクションプロパティを更新し、変更の確認を返します。

例 ​

workato connections update --connection-id 123 --name 'Updated Connection Name'

workato connections pick-list ​

レシピ設定で使用するために、コネクションから動的ピックリスト値を取得します。

利用状況 ​

workato connections pick-list [OPTIONS]

オプション ​

結果 ​

レシピフィールドマッピングで使用できる使用可能なピックリストオプションを返します。

例 ​

workato connections pick-list --connection-id 123 --object-name sobjects

workato connectors list ​

標準コネクターとカスタムコネクターの両方を含む、Workatoプラットフォームで使用可能なすべてのコネクターを一覧表示します。

利用状況 ​

workato connectors list [OPTIONS]

オプション ​

結果 ​

名前、プロバイダーID、認証タイプ、可用性を含むコネクターのテーブルを表示します。

例 ​

workato connectors list

workato connectors list --custom

workato connectors parameters ​

特定のコネクターのコネクションパラメーターと認証要件を表示します。

利用状況 ​

workato connectors parameters [OPTIONS]

オプション ​

結果 ​

コネクションフィールド、認証方法、設定オプションを表示します。

例 ​

workato connectors parameters --provider salesforce

workato connectors parameters --oauth-only

workato data-tables list ​

スキーマとレコード数情報を含め、現在のワークスペース内のすべてのData tablesを一覧表示します。

利用状況 ​

workato data-tables list

結果 ​

ID、名前、スキーマフィールド、レコード数を含むData tablesのテーブルを表示します。

例 ​

workato data-tables list

workato data-tables create ​

レシピで構造化データを保存するために、指定したスキーマを持つ新しいデータテーブルを作成します。

利用状況 ​

workato data-tables create [OPTIONS]

オプション ​

結果 ​

新しいデータテーブルを作成し、テーブルIDとスキーマ確認を返します。

例 ​

workato data-tables create --name 'Customer Data'

workato data-tables create --name 'Products' --schema-json '[{"name":"product_id","type":"string","optional":false}]'

workato properties list ​

設定管理のためにレシピで使用できるEnvironmentまたはプロジェクトプロパティを一覧表示します。

利用状況 ​

workato properties list [OPTIONS]

オプション ​

結果 ​

名前、値（機密データはマスク）、スコープを含むプロパティを表示します。

例 ​

workato properties list

workato properties list --prefix salesforce_

workato properties upsert ​

Environmentまたはプロジェクトレベルの設定用のプロパティを作成または更新します。

利用状況 ​

workato properties upsert [OPTIONS]

オプション ​

結果 ​

プロパティを作成または更新し、行われた変更を確認します。

例 ​

workato properties upsert --project-id 123 --file properties.json

workato properties upsert --key-value api_endpoint=https://api.example.com

workato api-collections list ​

外部利用向けにレシピをRESTエンドポイントとして公開するAPIコレクションを一覧表示します。

利用状況 ​

workato api-collections list [OPTIONS]

オプション ​

結果 ​

ID、名前、プロジェクト、エンドポイント数を含むAPIコレクションを表示します。

例 ​

workato api-collections list

workato api-collections create ​

レシピエンドポイントをグループ化して管理するための新しいAPIコレクションを作成します。

利用状況 ​

workato api-collections create [OPTIONS]

オプション ​

結果 ​

新しいAPIコレクションを作成し、コレクションIDと設定の詳細を返します。

例 ​

workato api-collections create --name 'Customer API'

workato api-collections list-endpoints ​

特定のコレクション内のすべてのAPIエンドポイントを、ステータスと設定とともに一覧表示します。

利用状況 ​

workato api-collections list-endpoints [OPTIONS]

オプション ​

結果 ​

ID、名前、HTTPメソッド、パス、有効ステータスを含むエンドポイントを表示します。

例 ​

workato api-collections list-endpoints --api-collection-id 456

workato api-collections enable-endpoint ​

特定のAPIエンドポイントを有効化して、外部API呼び出しで使用できるようにします。

利用状況 ​

workato api-collections enable-endpoint [OPTIONS]

オプション ​

結果 ​

エンドポイントを有効化し、APIアクセス用の公開URLを提供します。

例 ​

workato api-collections enable-endpoint --api-endpoint-id 789

workato api-clients list ​

Workato APIへのプログラムによるアクセスに使用されるAPIクライアントを、権限およびステータスとともに一覧表示します。

利用状況 ​

workato api-clients list [OPTIONS]

オプション ​

結果 ​

ID、名前、説明、権限スコープを含むAPIクライアントを表示します。

例 ​

workato api-clients list

workato api-clients create ​

Workato APIへのプログラムによるアクセス用に新しいAPIクライアントを作成します。

利用状況 ​

workato api-clients create [OPTIONS]

オプション ​

結果 ​

APIクライアントを作成し、クライアントIDと初期アクセス認証情報を返します。

例 ​

workato api-clients create --name 'Integration Client' --description 'For external system integration'

workato guide topics ​

統合ヘルプシステムで使用可能なすべてのドキュメントトピックを一覧表示します。

利用状況 ​

workato guide topics

結果 ​

説明と内容の概要を含む使用可能なヘルプトピックを表示します。

例 ​

workato guide topics

workato guide search ​

統合ドキュメントで特定の用語または概念を検索します。

利用状況 ​

workato guide search <QUERY> [OPTIONS]

入力 ​

オプション ​

結果 ​

強調表示された検索語を含む関連ドキュメントセクションを返します。

例 ​

workato guide search 'oauth connection'

workato guide search 'trigger' --topic recipes --max-results 5

workato guide content ​

特定のドキュメントトピックの完全な内容を表示します。

利用状況 ​

workato guide content <TOPIC>

入力 ​

結果 ​

指定したトピックの完全なドキュメント内容を表示します。

例 ​

workato guide content recipes

workato assets ​

レシピ、コネクション、Data tables、フォルダを含む現在のワークスペース内のすべてのアセットを一覧表示します。

利用状況 ​

workato assets [OPTIONS]

オプション ​

結果 ​

タイプ、名前、ID、フォルダの場所を含む包括的なアセットインベントリを表示します。

例 ​

workato assets

workato assets --output-format json

Environment変数 ​

CLIは次のEnvironment変数をサポートしています:

• WORKATO_PROFILE: 使用するデフォルトプロファイル
• WORKATO_API_TOKEN: 認証用APIトークン
• WORKATO_API_HOST: カスタムAPIホストURL

グローバルパターン ​

次のパターンはすべてのCLIコマンドに適用され、認証、データ処理、エラー管理に一貫した動作を提供します。

認証 ​

すべてのコマンドには次のいずれかによる認証が必要です:

• プロファイル設定（推奨）
• Environment変数
• コマンドラインオプション

ページネーション ​

一覧表示コマンドは次を使用したページネーションをサポートします:

• --page INTEGER: ページ番号（デフォルト: 1）
• --per-page INTEGER: ページあたりの項目数（デフォルトは異なります、最大: 100）

出力形式 ​

多くのコマンドは次をサポートします:

• --output-format table: 人間が読みやすいテーブル（デフォルト）
• --output-format json: 機械可読JSON

エラー処理 ​

CLIには、エラー対応を支援する次の機能があります:

• コンテキストを含む詳細なエラーメッセージ
• 一般的な問題に対する提案
• APIエラーのHTTPステータスコード情報
• 不正な形式の入力に対する検証フィードバック

一般的なワークフロー ​

次の例では、開始、レシピの開発、コネクションの管理、APIの操作に関する一般的なワークフローを示します。 これらのパターンは、特定の要件に合わせて組み合わせたり調整したりできます。

初期セットアップ ​

workato init                    # Interactive setup
workato workspace              # Verify configuration
workato pull                   # Sync with workspace

Developmentサイクル ​

workato recipes validate --path recipe.json
workato push --restart-recipes
workato recipes list --running

コネクション管理 ​

workato connectors list --search salesforce
workato connections create --provider salesforce --name "Prod SF"
workato connections create-oauth --parent-id 123

API管理 ​

workato api-collections create --name "Customer API"
workato api-collections list-endpoints --api-collection-id 456
workato api-collections enable-endpoint --api-endpoint-id 789