uip is connectors

「uip is connectors」の構文とオプション - Integration Service のコネクタ カタログを参照し、コネクタの検出メタデータ、スキーマ、監査履歴を調べます。

uip is connectors は、Integration Service のコネクタ カタログ (テナントが認証できるすべての連携 (Salesforce、Slack、Zoho Desk など) を参照し、1 つのコネクタの検出メタデータ、OpenAPI ドキュメント、イベント操作、監査履歴を調べます。読み取り専用です。これらの動詞はいずれもコネクタを作成または変更しません。list は、その結果をテナントごとにディスクにキャッシュします。 --refresh 渡して、新規取得を強制します。get および以下の他のすべての動詞は、常にAPIを直接呼び出し、そのキャッシュには決して触れません。

概要

uip is connectors <verb> [options]

動詞

動詞	目的
list	テナントで利用可能なコネクタのリストを表示します。必要に応じて、名前またはキーでフィルター処理します。
get	1 つのコネクタの詳細をキーで取得します。
metadata	コネクタの検出メタデータ (機能フラグ、層、検出の種類) を取得します。
swagger	コネクタ要素の OpenAPI ドキュメントを取得します。
event-operations	コネクタ要素がサポートするイベント操作を挙げる。
audit-logs	コネクタ要素のバージョンの監査ログ エントリのリストを表示します。
export	コネクタ要素のパッケージをローカル ファイルにエクスポートします。

uip is connectors list

現在のテナントで利用可能なコネクタのリストを表示します。テナントごとにディスクにキャッシュされます。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-f	--filter	text	—	部分文字列がコネクタ名またはキーと一致します。
—	--refresh	フラグ	無効	キャッシュを無視して、API からの再取得を強制します。

例

uip is connectors list

uip is connectors list --filter zoho

uip is connectors list --filter slack \
    --output-filter 'Data[].{name:Name, key:Key}'

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

{
  "Code": "ConnectorList",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "Vendor": "",
      "Active": "No",
      "CatalogActive": "No",
      "Version": "",
      "Stage": "",
      "DapCompatible": "No"
    }
  ]
}

一致するコネクタがない場合、コマンドは Code: "Message" と Data: { "Message": "No connectors found." }で成功します。

uip is connectors get

1 つのコネクタの完全なレコードをキーで返します。常に API を直接呼び出します。キャッシュされません。

引数

名前	Required	目的
<connector-key>	○	コネクタ キー (例: uipath-zoho-desk[ connectors list] で検索します。

オプション

グローバル オプション以外にはありません。

例

uip is connectors get uipath-zoho-desk

uip is connectors get uipath-zoho-desk \
    --output-filter 'Data[0].{events:HasEvents, cruds:HasCruds}'

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

{
  "Code": "Connector",
  "Data": [
    {
      "Id": 492,
      "Name": "Zoho Desk",
      "Key": "uipath-zoho-desk",
      "AppName": "",
      "Vendor": "",
      "Description": "Zoho Desk streamlines customer service, boosts agent efficiency and deliver lasting customer experiences",
      "Image": "https://example.com/zoho-desk/image",
      "Active": "No",
      "HasEvents": "Yes",
      "HasCruds": "No",
      "HasMethods": "No",
      "HasHttpRequest": "Yes",
      "DapCompatible": "No",
      "Categories": "IT and help desk",
      "Tags": "Service desk, Agents, Tickets",
      "DocumentationUrl": "No documentation"
    }
  ]
}

完全なフィールドのリスト (すべて返されます): Id、 Name、 Key、 AppName、 Vendor、 Description、 Image、 Active、 HasEvents、 HasCruds、 HasMethods、 HasHttpRequest、 DapCompatible、 Categories、 Tags、 DocumentationUrl。Description は "No description" を読み取り、 DocumentationUrl は、カタログに空の文字列ではなく、そのコネクタのファイルに何もない場合に "No documentation" を読み取ります。

UIP IS コネクタのメタデータ

コネクタの検出メタデータを取得する。機能フラグ (イベント、CRUD、カスタム オブジェクト/フィールドの検出などがサポートされているか)、層、検出の種類、テナント固有の機能フラグがあります。

引数

名前	Required	目的
<connector-key>	○	コネクタ キー (例: uipath-salesforce-sfdc

オプション

グローバル オプション以外にはありません。

例

uip is connectors metadata uipath-salesforce-sfdc

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

{
  "Code": "ConnectorMetadata",
  "Data": [
    {
      "Key": "uipath-salesforce-sfdc",
      "Name": "Salesforce",
      "Description": "CRM",
      "Vendor": "Salesforce",
      "Version": "1.0.0",
      "DiscoveryType": "dynamic",
      "Tier": "1",
      "IsActive": true,
      "IsPrivate": false,
      "IsOwner": true,
      "HasEvents": true,
      "HasCRUDs": true,
      "HasMethods": false,
      "HasSearchMethods": false,
      "HasHttpRequest": true,
      "HasExtensions": false,
      "HasObjectDiscovery": true,
      "HasFieldDiscovery": true,
      "HasCustomObjectDiscovery": true,
      "HasCustomFieldDiscovery": true,
      "DapCompatible": true,
      "UnifiedTypesCompatible": false,
      "HideActivities": false,
      "ShouldLocaliseOnlyCurated": false,
      "Flags": {}
    }
  ]
}

注:

このコマンドは、カタログがコネクタに対して返すすべてのブール値プロパティを公開し、上記の固定セットだけでなく、カタログに追加された新しい機能フラグは、CLI リリースを待たずに自動的にここに表示されます。

UIP IS コネクタ Swagger

コネクタ要素の操作を記述した OpenAPI (Swagger) ドキュメントを取得します。

引数

名前	Required	目的
<connector-key>	○	コネクタ キー。

オプション

長押し	値 (Value)	説明
--version	text	要素のバージョン。コネクタの既定/最新バージョンの使用を省略します。

例

uip is connectors swagger uipath-zoho-desk

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

{
  "Code": "ElementSwagger",
  "Data": {
    "openapi": "3.0.1",
    "info": {
      "title": "Zoho Desk",
      "version": "1.0.0"
    }
  }
}

Data はカタログによって返される生のOpenAPIドキュメントです—その形状は、このCLIの通常のパスカルケースエンベロープ規則ではなく、OpenAPI仕様に従います。

uip is コネクタ event-operations

コネクタ要素がサポートするイベント操作 (そのコネクタで uip is triggers 可能な操作) を一覧表示します。

引数

名前	Required	目的
<connector-key>	○	コネクタ キー。

オプション

長押し	値 (Value)	説明
--version	text	要素のバージョン。コネクタの既定/最新バージョンの使用を省略します。

例

uip is connectors event-operations uipath-zoho-desk

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

{
  "Code": "ElementEventOperationList",
  "Data": [
    { "name": "CREATED", "displayName": "Created" }
  ]
}

空の結果は Instructions: "No event operations found for connector '<connector-key>'."で引き続き成功します。

uip is コネクタ audit-logs

コネクタ要素のバージョン (スキーマの変更、パブリッシュ、および同様のカタログ側のイベント) について記録された監査ログ エントリのリストを作成します。

引数

名前	Required	目的
<connector-key>	○	コネクタ キー。

オプション

長押し	値 (Value)	説明
--version	text	必須。監査ログを取得する要素のバージョンです。
--limit	Number	ページ サイズ
--next-page	トークン	次のページを取得するには、前の応答からカーソルを指定します。

例

uip is connectors audit-logs uipath-zoho-desk --version 1.0.0 --limit 50

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

{
  "Code": "ElementAuditLogList",
  "Data": [
    { "changeType": "Updated", "user": "[e-mail]" }
  ]
}

空の結果は Instructions: "No audit logs found for connector '<connector-key>' version '<version>'."で引き続き成功します。

UIP IS コネクタのエクスポート

コネクタ要素のパッケージをローカル ファイルにエクスポートします。

引数

名前	Required	目的
<connector-key>	○	コネクタ キー。

オプション

長押し	値 (Value)	説明
--output-file	パス	必須。アップロード先ファイルのパス。
--version	text	要素のバージョン。コネクタの既定/最新バージョンの使用を省略します。

例

uip is connectors export uipath-zoho-desk --output-file ./uipath-zoho-desk.zip

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

{
  "Code": "ElementExported",
  "Data": {
    "ConnectorKey": "uipath-zoho-desk",
    "Version": "",
    "OutputFile": "/work/uipath-zoho-desk.zip",
    "Bytes": 1024
  }
}

Version は、渡された --version (省略する場合は空の文字列) をエコー バックします。実際にエクスポートされたバージョン番号には解決されません。

関連

• uip is connections — ここで検出されたコネクタに対する OAuth セッションを作成します。
• uip is activities — コネクタが公開する操作を一覧表示します。
• uip is resources — コネクタのデータプレーンオブジェクトを記述して実行します。
• uip is triggers — 上記のevent-operationsによってサポートされる、イベント ドリブンなコネクタ操作です。

参照

• Integration Service ツールの概要
• グローバル オプション
• 終了コード