[UIP Is コネクタ ビルダー] アクティビティ

Integration Service コネクタ ビルダーを使用してコネクタのアクティビティ (リソース、フィールド、メソッド、パラメーター) を作成するための構文とオプション。

uip is connectors builder activity は、コネクタのアクティビティ、すなわち Studio アクティビティとなる API エンドポイント (標準リソース ファイルでは リソース と呼ばれる) を、そのフィールド、メソッド、パラメーターとともに作成します。これは、コネクタ ビルダー内で最大かつ最も詳細なドメインです。ここにも適用される共通の概念 (コネクタ - ディレクトリの解決、デザインとパブリッシュ、一般的な作成フロー) については、「 コネクタ ビルダー 」をご覧ください。

フック (リソースまたはグローバルにアタッチされた JavaScript の要求前/要求後の変換) は、入れ子になった activity hook のサブグループであり、独自のサイズと必要なランタイム コンテキストの詳細の量のために、 アクティビティ フック で個別に文書化されます。

注:

activity create は、auth-validation や onProvision などのライフサイクル エンドポイント用ではありません。これらは builder auth system create で作成されたシステム リソースです (「認証」を参照)。activity は、コネクタのユーザー向けの通常の操作用です。

概要

uip is connectors builder activity list [--method <method>] [--path <path>] [--connector-dir <path>]
uip is connectors builder activity get [<name>] [--name <name>] [--connector-dir <path>]
uip is connectors builder activity create --name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity delete <name> [--connector-dir <path>]

uip is connectors builder activity field schema
uip is connectors builder activity field list --resource <name> [--connector-dir <path>]
uip is connectors builder activity field get [<name>] --resource <name> [--name <name>] [--connector-dir <path>]
uip is connectors builder activity field create --resource <name> --name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity field delete [<name>] --resource <name> [--name <name>] [--connector-dir <path>]

uip is connectors builder activity method get --resource <name> --method <method> [--connector-dir <path>]
uip is connectors builder activity method set --resource <name> --method <method> [options...] [--connector-dir <path>]
uip is connectors builder activity method curate --resource <name> --method <method> --display-name <name> [options...] [--connector-dir <path>]

uip is connectors builder activity param list --resource <name> --method <method> [--connector-dir <path>]
uip is connectors builder activity param get --resource <name> --method <method> --name <name> [--connector-dir <path>]
uip is connectors builder activity param create --resource <name> --method <method> --name <name> --type <type> [options...] [--connector-dir <path>]
uip is connectors builder activity param delete --resource <name> --method <method> --name <name> [--connector-dir <path>]

概念

• リソース element.json— 名前、パス、または METHOD:/path セレクター (例:GET:/accounts)。activity create は検索 または追加操作 です。既存のリソース名に対して再度実行すると、リソースが上書きされるのではなく、新しいメソッド/フィールドが追加されます。
• フィールド — リソースの標準リソース (SR) ファイルに格納される、リソースの UI に面したプロパティです。フィールドには、HTTP メソッドごとの可視性 (要求本文の一部か、応答か、必須か) に加えて、表示方法に関する任意のデザイン メタデータ (ドロップダウン、依存ドロップダウン、非表示、並べ替え順序) があります。
• メソッド — リソースの HTTP メソッドごとの標準リソース構成 (操作ラベル、内部パス、キュレーションの状態、説明)。activity method curate メソッドをスタンドアロンの Studio アクティビティに昇格させます。
• Param — element.json に格納され、SR にミラーリングされるランタイム要求パラメータ (クエリ、パス、ヘッダー、または本文) です。フィールドとは異なり、パラメーターは、値が静的な UI プロパティとしてどのように表示されるかではなく、値がベンダーの API 呼び出しに到達する方法を記述します。ただし、パラメーターは、フィールドと同じ参照/列挙型フラグを使用してドロップダウンになることもできます。
• ドロップダウン/依存ドロップダウン — field create と param create は、値を別のリスト リソースに対するルックアップにワイヤリングするために、同一のフラグのセット (--reference、 --reference-object、 --reference-path、 --lookup-value、 --lookup-names、 --display-pattern、 --filter-pattern、 --load-by-default、 --multi-select、 --enable-user-override、 --depends-on、 --field-actions) を共有します。--depends-on <parentField> は、依存ドロップダウンの標準の表示/非表示ルールのペアを生成するショートカットです (親に値が設定されるまで非表示)。 --field-actions は、 --depends-on 表現できない条件の生の JSON エスケープ ハッチです。
• マージ セマンティクス — field create、 param create ( create or replace 経由 — 以下を参照)、および method set はすべて既定で既存のエントリにマージされます: 渡したキーは Win で、省略したキーは既存の定義から保持され、フィールドのメソッドごとの可視性は深くマージされるため、あるメソッドの可視性を追加しても別のメソッドの可視性が低下することはありません。method set --replace は例外で、メソッドの設定全体が上書きされ、再渡されなかったもの (パラメーターやキュレーションされた状態を含む) がすべて削除されます。
• 表示フラグの設定を解除する — field create --method 'GET=!request' (! のプレフィックスに注意) は、マージのGETのrequestの可視性をそのままにするのではなく明示的にオフにします。!がない場合、フラグは加算されるだけです。

UIP is コネクタ ビルダーのアクティビティのリスト

リソース エントリ element.json リスト (任意でフィルター処理)。

オプション

長押し	値 (Value)	説明
--method <method>	string	HTTP メソッド (GET、 POST、 など) でフィルター処理します。
--path <path>	string	正確なリソース パスでフィルター処理します (例:/accounts)。
--connector-dir <path>	パス	コネクタ ディレクトリ。解決順序については、「 コネクタ ビルダー」→「概念 」をご覧ください。

例

uip is connectors builder activity list
uip is connectors builder activity list --method GET

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

{ "Code": "ResourceList", "Data": { "Resources": [] } }

UIP is コネクタ ビルダー アクティビティの取得

名前、パス、またはMETHOD:/path セレクターで、element.jsonリソース エントリを 1 つ取得します。

引数

名前	Required	目的
[name]	×	リソース名、パス、または METHOD:/path セレクター (例:accounts または 'GET:/accounts')。--nameとして渡すこともあります。

オプション

長押し	値 (Value)	説明
--name <name>	string	create/field get/param getとパリティが必要な場合の、位置引数の代替手段です。
--connector-dir <path>	パス	コネクタ ディレクトリ。

例

uip is connectors builder activity get accounts
uip is connectors builder activity get 'GET:/accounts'

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

{ "Code": "Resource", "Data": { "Resource": {} } }

UIP is コネクタ ビルダー アクティビティ 作成

完全なリソースを作成します。1 つの標準リソースのファイルと、メソッドごとに 1 つの element.json エントリを追加します。既存の --name に対して再実行すると、上書きされるのではなく、 が検索されて追加されます。

オプション

長押し	値 (Value)	Required	説明
--name <name>	string	○	リソース名 (パス セグメント)。
--display-name <name>	string	×	UI 表示名。既定値は --nameです。
--vendor-path <path>	string	×	ベンダーの API パス。既定値は /{name}です。
--resource-path <path>	string	×	ベンダーのパスと異なる場合の明示的なリソース パス。
--methods <csv>	csv	×	作成する HTTP メソッド。既定 GET,GETBYID,POST,PATCH,DELETEです。
--method-vendor-path <kv>	key=value、 繰り返し可能	×	メソッドごとのベンダー パスの上書き (例:GET=/me/teamsです。
--primary-key <name>	string	×	主キー フィールドの名前。既定 idです。
--no-body	フラグ	×	POST/PUT/PATCH で自動追加された request-body パラメーターを省略します。これは、パスに ID のみを必要とする開始/停止呼び出しなどのパスのみのアクションの場合に使用します。
--resource-type <type>	string	×	ResourceType 値 (api、 apiElementRequest、...)。既定 apiです。
--has-ceql	フラグ	×	GET で CEQL フィルター処理を有効化します。
--has-events	フラグ	×	リソースをイベント対応としてマークします。
--has-bulk	フラグ	×	一括ダウンロードのサポートを有効化します。
--pagination-type <type>	string	×	GET のページネーションの種類です。
--root-key <key>	string	×	レコードを保持する応答ルート キー。
--next-page-key <key>	string	×	次のページ トークンを伝送する応答キー。
--filter-param <vendorName>	string	×	CEQL フィルターがマップされるベンダーのクエリ パラメーター名です。既定の where (例:sysparm_query ServiceNow スタイルの API の場合は )。
--page-size-param <vendorName>	string	×	ページ サイズのベンダー クエリ パラメーター名。既定の pageSize (例:sysparm_limit、 per_page)。
--offset-param <vendorName>	string	×	行のオフセット/ページ番号のベンダー クエリ パラメーター名 (例:sysparm_offset、 page)。
--next-resource <selector>	string	×	次のリソース (例:'GET:/organization')。
--curated-metadata <json>	JSON	×	メソッドごとにキュレーションされたメタデータ、インライン--curated-metadata-fileと相互に排他的です。
--curated-metadata-file <path>	パス	×	ファイルからメソッドごとに選定されたメタデータ
--fields <json>	JSON	×	インライン JSON 配列としてのフィールドの仕様--fields-fileと相互に排他的です。形状については activity field schema を参照してください。
--fields-file <path>	パス	×	JSON ファイルからのフィールドの仕様
--skip-sr	フラグ	×	標準リソース ファイルの作成はスキップします。
--no-curate	フラグ	×	メソッドをスタンドアロンの Studio アクティビティに自動キュレーションしないでください。既定では、 はキュレーションです。
--overwrite-fields	フラグ	×	既存のリソースに追加する場合、名前の競合で入力フィールド定義が優先されます。既定では、既存の定義が保持されます。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

--fields と --fields-file の両方 (または --curated-metadata と --curated-metadata-fileの両方) を渡すとエラーになります。--fields/--fields-fileペイロードは、何かを書き込む前に検証され、正規化されるため、不正な形式のフィールド仕様は、壊れた標準リソースファイルをサイレントに作成するのではなく、正確なエラーで迅速に失敗します。

例

# CRUD resource with default methods
uip is connectors builder activity create --name accounts --vendor-path /accounts --has-ceql

# List-only resource with cursor pagination
uip is connectors builder activity create --name orders --methods GET \
  --pagination-type cursor --next-page-key nextCursor --root-key data

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

{
  "Code": "ResourceCreated",
  "Data": {
    "ResourceName": "accounts",
    "ConnectorRoot": "/work/my-connector",
    "ResourceType": "api",
    "SrResolution": "created",
    "MethodsAdded": ["GET", "GETBYID", "POST", "PATCH", "DELETE"],
    "ElementEntriesAdded": 5,
    "ElementEntriesSkipped": 0,
    "FieldsCount": 0,
    "ParamsSyncedFromElement": 0,
    "StandardResourceFile": "app/element/accounts.js",
    "SkipSr": false,
    "Warnings": []
  }
}

UIP is コネクタ ビルダー アクティビティの削除

リソースの削除: 一致するすべての element.json エントリとその標準リソース ファイル。

引数

名前	Required	目的
<name>	○	リソース名。

オプション

長押し	値 (Value)	説明
--connector-dir <path>	パス	コネクタ ディレクトリ。

例

uip is connectors builder activity delete accounts

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

{
  "Code": "ResourceRemoved",
  "Data": {
    "ResourceName": "accounts",
    "RemovedEntries": 5,
    "StandardResourceRemoved": true
  }
}

これにより、リソース全体が削除されます。代わりに、1 つのメソッドを削除するには、 を使用してリソースを狭く編集するか、 activity method set --replaceを使用してリソースを絞り込んで編集するか、削除して--methods数を絞り直したリストで再createします。専用の「メソッドを 1 つ削除」という動詞はありません。

---

アクティビティ フィールド

リソースの標準リソース フィールド (UI に面した形状) を管理します。

UIP IS コネクタ ビルダー アクティビティのフィールド スキーマ

フィールド仕様のスキーマ (許可されているキー、型、可視性) と、activity create または activity field createで--fields/--fields-file ペイロードを作成するための有効な例を出力します。コネクタは不要です。コネクタに依存しない静的な参照コマンドです。

グローバルな引数やオプション以外の引数やオプションはありません。

例

uip is connectors builder activity field schema

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

ネイティブの小文字キー(PascalCasedではない)で返されるため、 example 配列は直接コピー/貼り付け-オーサリング可能です。

{
  "Code": "FieldSchema",
  "Data": {
    "keys": [
      { "key": "name", "required": true, "description": "REQUIRED. Field name; becomes the SR fields[] key (dotted a.b and arr[*].x allowed)." },
      { "key": "type", "required": false, "description": "Scalar type. Optional on merge; defaults to 'string' for a new field." }
    ],
    "types": ["string", "..."],
    "designPositions": ["primary", "secondary", "none"],
    "visibilityMethods": ["GET", "..."],
    "visibilityKeys": ["request", "response", "required", "requestCurated", "responseCurated"],
    "notes": [
      "Pass an ARRAY of these objects to --fields '<json>' or --fields-file <path> on `activity create`.",
      "The array is validated + normalized before anything is written; a bad shape fails fast listing every problem.",
      "Unknown top-level keys and duplicate names are rejected. Put 'required' inside a method entry, not at top level.",
      "To bulk-add fields to an EXISTING activity, re-run `activity create --name <same> --fields-file <path>` — it merges."
    ],
    "example": [
      { "name": "id", "type": "string", "primaryKey": true, "method": { "GET": { "response": true } } },
      { "name": "email", "type": "string", "displayName": "Email", "searchable": true, "searchableOperators": ["=", "!="], "method": { "GET": { "response": true }, "POST": { "request": true, "response": true, "required": true } } }
    ]
  }
}

完全なキー リスト (ソースから提供) には、 nativeType、 description、 sampleValue、 format、 mask (日付/数値 形式のパターン文字列、例:"yyyy-MM-dd'T'HH:mm:ssZ" — ブール値ではありません)、 design、 methods ( methodのエイリアスです。両方ではありません)、 enum、 enhancedEnum、 reference、 sortOrder、 searchableNames、 defaultValue、 custom、 order、 isCuratedEventField、 isPriority、 key、 fieldActionsです。

UIP is コネクタ ビルダー アクティビティのフィールド リスト

リソースの standard-resource のすべてのフィールドのリストを取得します。

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

例

uip is connectors builder activity field list --resource accounts

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

{ "Code": "FieldList", "Data": { "Resource": "accounts", "Fields": [] } }

UIP is コネクタ ビルダー アクティビティ フィールド Get

1 つのフィールドを名前で読み取ります。

引数

名前	Required	目的
[name]	×	フィールド名 (または渡す --name)。

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--name <name>	string	×	位置引数の代替手段。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

例

uip is connectors builder activity field get --resource accounts name

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

{ "Code": "Field", "Data": { "Resource": "accounts", "Field": {} } }

UIP is コネクタ ビルダー アクティビティ フィールド 作成

リソースの standard-resource のフィールドを作成または更新します。既存のフィールドで再実行するとマー ジされます: 渡した最上位のキーは Win であり、未指定のキーは保持され、メソッドごとの可視性は深くマージされるため、メソッドの可視性を追加しても別のメソッドの可視性が削除されることはありません。

ランタイム要求パラメーターを追加するためのものではありません。追加には activity param create を使用してください。

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--name <name>	string	○	フィールド名 ( fields マップのキーになります)。
--type <type>	string	いいえ*	フィールドの種類です (string、 integer、 など)。新しいフィールドに必要です。既存のものにマージする場合は任意です。
--native-type <type>	string	×	ベンダーのネイティブ型名です。既定値は --typeです。
--display-name <name>	string	×	UI 表示名。
--description <text>	string	×	フィールドの説明。
--sample-value <value>	string	×	デザイナーに表示されるサンプル値です。
--format <format>	string	×	フィールド形式のヒント (例:date-time、 int32)。
--enum <json>	JSON	×	許可される値 — ベア ["a","b"] または [{"value":"a"}]です。
--enhanced-enum <json>	JSON	×	ラベル付きオプション: [{"name":"Label","value":"V"}]。
--reference <json>	JSON	×	JSON としての動的検索 (例:{"objectName":"users","path":"/users","lookupValue":"id","lookupNames":["name"]}です。
--reference-object <name>	string	×	ドロップダウン: ターゲット リスト リソースのオブジェクト名 (例:teams)。
--reference-path <path>	string	×	ドロップダウン: リスト リソース パス (例:/teams)。依存するドロップダウンには {parent} を使用します。例:/teams/{team_id}/channelsです。
--lookup-value <field>	string	×	ドロップダウン: 値として送信される 1 つのフィールドです。
--lookup-names <csv>	csv	×	ドロップダウン: 表示パターンの表示候補フィールドです。
--display-pattern <pattern>	string	×	ドロップダウン: 表示するラベル テンプレート (例:"{displayName}" または "{name} - {id}"です。
--filter-pattern <pattern>	string	×	ドロップダウン: サーバー側の先行入力フィルター テンプレートです。 {filter}
--load-by-default	フラグ	×	ドロップダウン: [open] にリストを設定します。
--multi-select	フラグ	×	ドロップダウン: 複数の値を選択できます。
--enable-user-override	フラグ	×	ドロップダウン: ユーザーが選択するのではなく、生の値を入力できるようにします。
--depends-on <parent>	string	×	[依存] ドロップダウン: 値が <parent> されるまで非表示にします (表示/非表示ルールのペアを生成)。参照パスには が含まれている必要があります{<parent>}
--field-actions <json>	JSON	×	ルールを JSON として表示/非表示/必須 — --depends-onを超えるエスケープ ハッチングです。
--default-value <value>	スカラーまたは JSON	×	既定値です。
--mask <pattern>	string	×	日付/数値の書式パターン (例:"yyyy-MM-dd'T'HH:mm:ssZ"です。
--primary-key	フラグ	×	フィールドを主キーとして指定します。
--sort-order <n>	integer	×	並べ替え順序。
--searchable	フラグ	×	フィールドを検索可能としてマークします。
--searchable-operators <csv>	csv	×	検索可能な演算子。
--searchable-names <csv>	csv	×	クエリで一致させる代替名。
--method <method>	文字列、繰り返し可能	×	HTTP メソッド: 表示フラグが適用される対象です。2 つの形式を混在可能にします: 均一 (--method GET --method POST --response 両方に同じフラグを適用) またはメソッドごとにインライン (--method 'GET=response' --method 'POST=request,required')。フラグの先頭に ! を付けて、マージで設定を解除します (例:--method 'GET=!request'です。
--request	フラグ	×	フィールドは、各 --methodの要求の一部です。
--response	フラグ	×	フィールドは、各 --methodの応答の一部です。
--required	フラグ	×	フィールドは、 --methodごとに必須です。
--request-curated	フラグ	×	フィールドは、 --methodごとにリクエストによってキュレーションされます。
--response-curated	フラグ	×	フィールドは、 --methodごとに回答によってキュレーションされます。
--design-position <position>	primary|secondary|none	×	設計位置。
--component <component>	string	×	設計コンポーネントの上書き。
--hidden	フラグ	×	デザイナーでフィールドを非表示にします。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

メソッドごとのインライン表示トークンは、 request、 response、 required、 requestCurated (または request-curated)、 responseCurated (または response-curated) です。認識されないトークンは失敗し、有効なセットのリストを示す明示的なエラーが表示されます。

例

# String field, visible as a response on both GET and POST
uip is connectors builder activity field create --resource accounts --name email \
  --type string --method GET --method POST --response

# Add request visibility on PATCH without dropping the existing GET/POST visibility (merges)
uip is connectors builder activity field create --resource accounts --name email \
  --type string --method PATCH --request

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

{
  "Code": "FieldWritten",
  "Data": {
    "Resource": "accounts",
    "FieldName": "email",
    "Field": { "name": "email", "type": "string" },
    "Outcome": "created"
  }
}

UIP is コネクタ ビルダー アクティビティ フィールドの削除

名前でフィールドを削除する

引数

名前	Required	目的
[name]	×	フィールド名 (または渡す --name)。

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--name <name>	string	×	位置引数の代替手段。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

例

uip is connectors builder activity field delete --resource accounts email

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

{ "Code": "FieldRemoved", "Data": { "Resource": "accounts", "FieldName": "email" } }

---

アクティビティの方法

リソースのメソッドごとの標準リソース構成 (操作ラベル、内部パス、検査状態) を管理します。

UIP はコネクタ ビルダー アクティビティ メソッド Get

メソッドの標準リソース構成を読み取ります。

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--method <method>	string	○	HTTP メソッド (GET、 POST、 など)。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

例

uip is connectors builder activity method get --resource accounts --method GET

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

{
  "Code": "Method",
  "Data": { "Resource": "accounts", "Method": "GET", "VendorPath": "/accounts", "Config": {} }
}

standard-resource 構成は内部パスのみを保持するため、VendorPath別に表示されます。ベンダー向けルーティングは element.jsonにあります。

UIP is コネクタ ビルダー アクティビティ メソッド セット

メソッドの標準リソース構成を作成または編集します。既定で既存の構成に渡したフラグをマージします。代わりに、 --replace ブロック全体が上書きされます。

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--method <method>	string	○	HTTP メソッド。
--operation <operation>	string	×	操作ラベル (List、 Retrieve、...)。
--operation-id <id>	string	×	操作の識別子。
--description <text>	string	×	メソッドの説明。
--path <path>	string	×	標準リソース メソッドのパス。
--hidden	フラグ	×	メソッドをデザイナーに非表示にします。
--has-ceql	フラグ	×	このメソッドでは CEQL を有効化します。
--response-display-name <name>	string	×	応答の表示名。
--response-description <text>	string	×	応答の説明。
--replace	フラグ	×	マージするのではなく、メソッド構成全体を上書きします。パラメーターを削除するか、キュレーションされたステートは再渡されません。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

例

uip is connectors builder activity method set --resource accounts --method GET \
  --operation List --path /accounts --has-ceql

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

{ "Code": "MethodSet", "Data": { "Resource": "accounts", "Method": "GET", "Outcome": "updated" } }

UIP is コネクタ ビルダー アクティビティ メソッドのキュレーション

メソッドをスタンドアロンの Studio アクティビティに昇格させる。

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--method <method>	string	○	HTTP メソッド。
--display-name <name>	string	○	Studio アクティビティの表示名です。
--name <name>	string	×	アクティビティ識別子。既定値は表示名です。
--description <text>	string	×	アクティビティの説明。
--hidden	フラグ	×	アクティビティを非表示にします。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

実際に渡したフラグのみが送信されます — 識別子をリセットしたり、説明を空白にしたりするのではなく、表示名のみの呼び出しが既存のキュレーションされたブロックにマージされます。

例

uip is connectors builder activity method curate --resource accounts --method GET \
  --display-name 'List Accounts'

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

{ "Code": "MethodCurated", "Data": { "Resource": "accounts", "Method": "GET", "Curated": {} } }

---

アクティビティ パラメーター

リソース メソッドのランタイム パラメーターを element.json で管理します (標準リソースにミラーリングされます)。

UIP is コネクタ ビルダー アクティビティのパラメーター リスト

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--method <method>	string	○	HTTP メソッド。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

例

uip is connectors builder activity param list --resource accounts --method GET

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

{ "Code": "ParamList", "Data": { "Resource": "accounts", "Method": "GET", "Parameters": [] } }

UIP is コネクタ ビルダー アクティビティ パラメーター Get

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--method <method>	string	○	HTTP メソッド。
--name <name>	string	○	パラメーター名。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

例

uip is connectors builder activity param get --resource accounts --method GET --name where

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

{ "Code": "Param", "Data": { "Resource": "accounts", "Method": "GET", "Param": {} } }

UIP is コネクタ ビルダー アクティビティ パラメーター 作成

リソース メソッドのパラメーターを作成または置換する。

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--method <method>	string	○	HTTP メソッド。
--name <name>	string	○	パラメーター名。
--vendor-name <name>	string	×	ベンダー側のパラメーター名。
--type <type>	string	○	パラメータ型 param create --help — CLI のパラメータ型レジストリ (--type は、とりわけ、プレーンなスカラー型や定数の value/configuration や 1 対 1 の設定マップなどの値を受け入れます — ここではフックを書くよりも宣言型を優先します)。
--vendor-type <type>	string	×	ベンダー側のパラメーター型。
--data-type <type>	string	×	データ型 (string、 integer、 など)。
--vendor-data-type <type>	string	×	ベンダー側のデータ型。
--source <source>	string	×	パラメーターのソース (request、 response)。
--required	フラグ	×	パラメーターを必須としてマークします。
--description <text>	string	×	パラメーターの説明。
--display-name <name>	string	×	UI 表示名。
--sort-order <n>	integer	×	並べ替え順序。
--enum <json>	JSON	×	許可される値、 field create --enum と同じ形状 — クエリ/本文パラメーターは静的なコンボにすることができます。
--enhanced-enum <json>	JSON	×	field create --enhanced-enumと同じ形状のラベル付きオプション。
--reference <json> / --reference-object / --reference-path / --lookup-value / --lookup-names / --filter-pattern / --display-pattern / --load-by-default / --multi-select / --enable-user-override / --depends-on / --field-actions	—	×	field createと同じ dropdown/dependent-dropdown フラグ — 上記のセクションをご覧ください。パス パラメーターまたはクエリ パラメーターをドロップダウンにすることもできます。
--design-position <position>	primary|secondary|none	×	設計位置。
--hidden	フラグ	×	デザイナーでパラメーターを非表示にします。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

--type 本当に必要です。その正確な許容値は CLI 独自のパラメータ型レジストリから取得され、 param create --helpによって完全に出力されるため、このページでは、出荷されたレジストリからドリフトするリストはハードコーディングされません。

例

uip is connectors builder activity param create --resource accounts --method GET \
  --name status --type query --data-type string

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

{
  "Code": "ParamWritten",
  "Data": {
    "Resource": "accounts",
    "Method": "GET",
    "ParamName": "status",
    "Param": { "name": "status", "type": "query" },
    "Outcome": "created",
    "SrSynced": true
  }
}

Warnings は、書き込みによって が生成された場合にのみ存在します。

uip is コネクタ ビルダー アクティビティ パラメーターの削除

オプション

長押し	値 (Value)	Required	説明
--resource <name>	string	○	リソース名。
--method <method>	string	○	HTTP メソッド。
--name <name>	string	○	パラメーター名。
--connector-dir <path>	パス	×	コネクタ ディレクトリ。

例

uip is connectors builder activity param delete --resource accounts --method GET --name status

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

{
  "Code": "ParamRemoved",
  "Data": { "Resource": "accounts", "Method": "GET", "ParamName": "status", "SrSynced": true }
}

関連

• コネクタ ビルダー — 概念とテナント ライフサイクルの 4 つの動詞
• アクティビティ フック — リソースまたはグローバルにアタッチされた JavaScript の要求前/要求後の変換です。
• 初期化 & コネクタ — このアクティビティが存在するコネクタの足場です。
• 認証 — ライフサイクル/システム リソースを含むコネクタの認証スキームを設定します。
• トリガーとステート — イベント トリガーと低レベルの要素ファイルの編集を行います。

参照

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