uip is resources

「uip is resources」の構文とオプション。コネクタ データ プレーン オブジェクトを一覧表示、説明、および操作を実行します。

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

重要:

データプレーン動詞グループはuip is resources runで、executeではありません。uip is resources execute ...存在せず、「unknown command」で失敗します。

概要

uip is resources <verb> [options]

動詞

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

uip is resources list

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--operation	ENUM	—	操作でフィルター処理: List、Retrieve、Create、Update、Delete、Replace
—	--connection-id	id	—	特定のコネクションをスコープ (カスタム オブジェクトを有効にする)。
—	--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 is resources describe

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

引数

名前	Required	目的
<connector-key>	○	コネクタ キー。
<object-name>	○	オブジェクト名 — アクティビティの設定 JSON の objectName です (例: tickets)。resources listで名前を検索する。両方の --activity-version 値でオブジェクトを同じ方法でアドレス指定します (以下を参照)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--connection-id	id	—	コネクションへのスコープ (カスタム フィールドが有効化され、 --fieldと一緒に必須)
—	--operation	ENUM	—	List、 Retrieve、 Create、 Update、 Delete、または Replace。--fieldとともに必要です。
—	--activity-version	1.0.0 | 4.0.0	1.0.0	クエリするアクティビティのメタデータ エンドポイント — 以下の 「アクティビティのメタデータ バージョン 」をご覧ください。
-f	--field	name=value	—	親フィールドの値です。繰り返し可能。コネクタの API の種類の ObjectAction (例: Jira の GenerateSchema、Salesforce の GenerateQuerySchema) を実行し、そのカスタム フィールドの応答を requestFieldsにマージします。--connection-id と --operationの両方が必要です。--activity-version 4.0.0ではサポートされていません。
—	--action	name	推論	明示的な API 型の ObjectAction 名です (例: GenerateSchema)。任意 — 省略する場合は --field 名から推論されます。複数のアクションが一致する可能性がある場合に、あいまいさを取り除くために渡します。
—	--refresh	フラグ	無効	キャッシュを無視して API から強制的に再取得します。また、デザインとアクションの応答は親フィールドの組み合わせによって異なるため、 --field 指定されるたびにキャッシュが自動的にバイパスされます。

アクティビティのメタデータのバージョン

--activity-version 、クエリ describe Integration Service のメタデータ エンドポイントを切り替えます。

• 1.0.0 (既定) — v3 要素エンドポイント、接続スコープ。デザインアクションの -f/--field ルックアップがサポートされています。
• 4.0.0 — v4 要素のエンドポイント。コネクションのスコープではありません。--connection-idを横に渡すことは受け入れられますが、v4はフェッチ自体にそれを必要としないため、無視されます(警告付き)。-f/--field は --activity-version 4.0.0 で完全に拒否されます。設計時 ObjectActionは v3 専用の、インスタンス スコープの機能です。

どちらの場合も、 <object-name> 位置は同じもの (オブジェクトの名前) を意味するため、2 つのバージョン間でアドレス指定の違いはなく、どのバックエンド エンドポイントが呼び出しに応答するかのみです。

例

# List operations available on this object (v3, default)
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'

# Describe a 4.0.0 activity by object name (v4 elements endpoints)
uip is resources describe uipath-salesforce-slack add_users_to_usergroup \
    --activity-version 4.0.0

# Parent-field values (Jira: project + issue type → custom fields for that combination)
uip is resources describe uipath-atlassian-jira curated_create_issue \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --operation Create \
    -f fields.project.key=ENGCE -f fields.issuetype.id=3

# Body-token parent field (Salesforce SOQL: query → response columns)
uip is resources describe uipath-salesforce-sfdc query_records \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --operation Create \
    -f query="SELECT Id, Name FROM Account WHERE Status = 'Active'"

注:

指定したフィールドのみ (コネクション独自のカスタム フィールドは存在しない) で -f/--field 呼び出しが返された場合、応答には Warningも含まれます。渡した値の 1 つがそのコネクションに存在しない可能性があります。そのフィールドのルックアップと照合します。

データシェイプ(--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が含まれます。

-f/--field (親フィールド/デザインアクションのルックアップ) を使用すると、requestFields に、結合されたコネクション固有のスキーマが反映されます。

{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "curated_create_issue",
    "operation": { "method": "POST", "name": "Create" },
    "requestFields": [
      { "name": "fields.project.key", "required": true, "displayName": "Project" },
      { "name": "fields.issuetype.id", "required": true, "displayName": "Issue type" },
      { "name": "fields.summary", "required": true, "displayName": "Summary" },
      { "name": "fields.description", "required": false, "displayName": "Description" }
    ]
  }
}

UIP はリソースが実行されます

コネクタのデータ プレーンを呼び出します。run 自体はグループです。実際の動詞は create、 list、 get、 update、 replace、 deleteです。すべての動詞には --connection-idが必要です。 create、 update、および replace には、さらに JSON 要求本文を使用した --body が必要です。delete 破壊 的 であり、 -y, --yes が必要です。CLI はプロンプトを表示しません。

uip is resources run create   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources run list     <connector-key> <object-name> --connection-id <id>
uip is resources run get      <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources run update   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources run replace  <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources run delete   <connector-key> <object-name> --connection-id <id> -y, --yes [--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	必須	データ プレーン コールの承認に使用される接続。
—	--query	Params	—	クエリ パラメーター。key=value&key=valueまたは JSON オブジェクトを受け入れます。
—	--body	JSON	—	要求本文。create、update、replaceに必要です。
-y	--yes	フラグ	—	deleteでのみ必要です。この元に戻せない操作を確認します。CLI はプロンプトを表示しません。

例

# Create a ticket
uip is resources run 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 run list uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

# Delete a ticket by ID — destructive, requires --yes
uip is resources run delete uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --query 'id=TK-1001' \
    --yes

データシェイプ(--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 ツールの概要
• グローバル オプション
• 終了コード