UIP はリソースです

uip is resources コネクタが処理するランタイム オブジェクト (チケット、連絡先、レコード、ファイル) を処理します。list は、コネクタのオブジェクトを列挙 describe 、1 つのオブジェクトのフィールド スキーマと操作を返し、接続に対してコネクタのデータ プレーン (作成/リスト/取得/更新/置換/削除) execute 呼び出します。すべての execute 動詞には --connection-idが必要です。キャッシュされたメタデータの読み取り(list、 describe)は、オプションでそれを受け入れて、カスタムオブジェクト/フィールドを表示します。

概要

uip is resources <verb> [options]

動詞

動詞	目的
list	コネクタで利用可能なオブジェクトのリストを取得します。必要に応じて、操作でフィルター処理します。
describe	1 つのオブジェクトの操作と項目スキーマについて説明する。
execute	コネクタのデータ プレーンを呼び出します (作成/リスト/取得/更新/置換/削除)。

uip is リソース リスト

コネクタで利用可能なオブジェクトのリストを取得します。結果は --connection-id が提供されるかどうかによって異なります—接続範囲のリストにはカスタムオブジェクトが含まれます。スコープのないリストはそうではありません (その場合、CLI は Warning を表示します)。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--operation	ENUM	—	操作でフィルター処理: List、Retrieve、Create、Update、Delete、Replace
—	--connection-id	id	—	特定のコネクションをスコープ (カスタム オブジェクトを有効にする)。
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--refresh	フラグ	無効	キャッシュを無視して、API からの再取得を強制します。

例

uip is resources list uipath-zoho-desk

# Only objects that support a Create operation
uip is resources list uipath-zoho-desk --operation Create

# Connection-scoped listing — includes custom objects
uip is resources list uipath-zoho-desk \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

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

{
  "Code": "ResourceList",
  "Data": [
    {
      "Name": "tickets",
      "DisplayName": "Tickets",
      "Path": "/tickets",
      "Type": "standard",
      "SubType": "standard",
      "Custom": "no",
      "ElementKey": "uipath-zoho-desk"
    }
  ]
}

uipはリソースの説明です

オブジェクトの項目と操作について説明する。--operationを指定しない場合は、利用可能な操作のリストとヒントを返します。--operationを使用すると、1 つの操作に絞り込まれ、そのパラメーター、要求フィールド、応答フィールドが返されます。

引数

名前	Required	目的
<connector-key>	○	コネクタ キー。
<object-name>	○	オブジェクト名 ( ticketsなど)。名前を resources listで検索します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--connection-id	id	—	コネクションのスコープ (カスタム フィールドを有効化)。
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--operation	ENUM	—	List、 Retrieve、 Create、 Update、 Delete、または Replace。
—	--refresh	フラグ	無効	キャッシュを無視して、API からの再取得を強制します。

例

# List operations available on this object
uip is resources describe uipath-zoho-desk tickets

# Field schema for the Create operation
uip is resources describe uipath-zoho-desk tickets --operation Create

# Required request fields, scripting-friendly
uip is resources describe uipath-zoho-desk tickets --operation Create \
    --output-filter 'Data.requestFields[?required].name'

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

--operationなし:

{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "tickets",
    "displayName": "Tickets",
    "elementKey": "uipath-zoho-desk",
    "availableOperations": [
      { "method": "GET", "name": "List", "description": "Search for Tickets", "path": "/tickets" },
      { "method": "POST", "name": "Create", "description": "Create a Tickets", "path": "/tickets" }
    ],
    "hint": "Use --operation <Create|List|Retrieve|Update|Delete|Replace> to see fields for a specific operation."
  }
}

--operation Createを使用すると、同じCode: "ResourceMetadata"が返されますが、ペイロードにはavailableOperationsではなく、operation、parameters、requestFields、responseFieldsが含まれます。

UIP はリソースを実行します。

コネクタのデータ プレーンを呼び出します。execute それ自体がグループです。実際の動詞は、 create、 list、 get、 update、 replace、および deleteです。すべての動詞には --connection-idが必要です。 create、 update、および replace では、JSON 要求本文を含む --body が追加で必要です。

uip is resources execute create   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute list     <connector-key> <object-name> --connection-id <id>
uip is resources execute get      <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources execute update   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute replace  <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute delete   <connector-key> <object-name> --connection-id <id> [--query <params>]

HTTP メソッド マッピング: create → POST、 list → GET (コレクション)、 get → GET-by-ID、 update → PATCH、 replace → PUT、 delete → DELETE。

引数

名前	Required	目的
<connector-key>	○	コネクタ キー。
<object-name>	○	オブジェクト名 ( ticketsなど)。

共有オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--connection-id	id	必須	データ プレーン コールの承認に使用される接続。
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--query	Params	—	クエリ パラメーター。key=value&key=valueまたは JSON オブジェクトを受け入れます。
—	--body	JSON	—	要求本文。create、update、replaceに必要です。

例

# Create a ticket
uip is resources execute create uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"subject":"New issue","departmentId":"DEP-1"}'

# List tickets — first page
uip is resources execute list uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

# Delete a ticket by ID
uip is resources execute delete uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --query 'id=TK-1001'

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

{
  "Code": "ExecuteOperation",
  "Data": { "id": "TK-1001", "subject": "New issue", "status": "Open" }
}

list操作は{ "items": [...] }を返し、バックエンドがElements-Has-More/Elements-Next-Page-Tokenヘッダーを介してより多くのページを通知するときに、HasMoreとNextPageTokenを持つPaginationオブジェクトを含めます。

失敗した呼び出しは、 Failure、HTTP ステータスが Messageに、サーバー本体が Instructionsとして表示されます。

関連

• uip is connections — --connection-id値は connections list / connections createから取得されます。
• uip is connectors — 最初にコネクタ キーを検出します。
• uip is activities — コネクタが公開する名前付き操作を参照してください。
• uip is triggers — ここでは、データプレーン動詞に対応するイベント駆動型の動詞です。

参照

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