uipは

uip is は Integration Service ツールです。外部 SaaS への OAuth 接続を仲介し、それらに対して CRUD アクティビティを実行するコネクタ プラットフォームを管理します。このツールは、コネクタ(カタログ)、コネクション(アカウントのOAuthセッション)、アクティビティ(コネクタごとの操作定義)、リソース(コネクタオブジェクトとそのデータプレーン操作)、トリガー(イベント駆動型コネクタ操作)の5つのリソースで構成されています。uip tools install isでインストールするか、uip is … を呼び出して自動インストールを実行します。インストール モデルについては 「ツール (プラグイン)」 を、ツールのインストールを管理するコマンドについては「 uip ツール 」を参照してください。is はコマンド プレフィックスです。基になるパッケージは @uipath/integrationservice-toolです。

ほとんどの読み取りコマンドは、対話型の使用の応答性を維持するために、テナントごとにディスク上の応答をキャッシュします。キャッシュされたコマンドに --refresh を渡して、強制的に新規フェッチを実行します。

リソース

各リソースには、独自のリファレンス ページがあります。各ページに設定された動詞は、 uip is によって登録されたコマンドと一致します— uip is --help を実行して、インストールの完全な表面を確認します。

リソース	目的
コネクタ	コネクタ カタログ — テナントが到達できるすべての連携。
コネクション	コネクタのテナント側の OAuth 資格情報/セッション。
アクティビティ	コネクタが公開する操作 (CreateTicket、 ListAllRecordsなど)。
リソース	コネクタ オブジェクト (チケット、連絡先、ファイル)、 describe およびランタイム オブジェクト execute。
トリガー	コネクタが起動できるイベント フック (CREATED、 UPDATED、 DELETED)

概要

uip is <resource> <verb> [options]

常に uip isし、 uip integration-serviceすることはありません。isツールのコマンドプレフィックスです(uip tools listの「commandPrefix」列を参照)。

共通フラグ

小さなフラグのセットがリソース動詞にまたがって繰り返されます。彼らはどこに現れても同じように振る舞います。

フラグ	使用者	目的
-t, --tenant <tenant-name>	すべての動詞	認証時に選択したテナントを上書きします。オプション;セッションのデフォルトを使用するには省略します。
--refresh	キャッシュされた読み取り動詞 (list、 describe、 get、 objects)	API から強制的に再取得し、ディスク上のキャッシュを更新します。
--connection-id <id>	多くの動詞	要求のスコープを 1 つのコネクションに設定します。すべての resources execute 動詞で必要です。メタデータの読み取りでは省略可能です。サーバーにカスタムオブジェクト/フィールドを含めることができます。

動詞固有のフラグ (フィルター、本文、クエリ パラメーター) は、各リソース ページに記載されています。

グローバルオプションと終了コード

すべての uip is 動詞は、4 つの グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) に従います。終了コードは共有 コントラクトに従います。

参照

• 概念: UiPath CLI の構成方法 — ホスト + ツール モデルの中でツールが適合する場所。
• セッション — テナント コンテキストの解決方法。
• 構成 — すべてのツールに影響を与える環境変数と構成ファイル。
• uip login — Integration Service のすべての呼び出しに使用されるセッションです。