uip df チョイス セット

Data Fabric の列挙値リストを管理する「uip df choice-sets」および「uip df choice-set-values」の構文とオプション。

uip df choice-set-valuesuip df choice-setsData Fabric チョイス セット — エンティティの CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE フィールドによって参照される列挙値のリストです。choice-sets はセット自体 (そのメタデータと許可値のリスト) を管理します。 choice-set-values セット内の個々の値を管理します。

概要

uip df choice-sets list [--folder-key <key> | --include-folders]
uip df choice-sets list-values <choice-set-id> [-l <n>] [-o <n> | --cursor <cursor>] [--folder-key <key>]
uip df choice-sets create <name> [--display-name <name>] [--description <text>] [--folder-key <key>]
uip df choice-sets update <choice-set-id> --display-name <name> --description <text> [--folder-key <key>]
uip df choice-sets delete <choice-set-id> -y --reason <text> [--folder-key <key>]

uip df choice-set-values create <choice-set-id> <name> [--display-name <name>] [--folder-key <key>]
uip df choice-set-values update <choice-set-id> <value-id> <display-name> [--folder-key <key>]
uip df choice-set-values delete <choice-set-id> --ids <id,id,...> -y --reason <text> [--folder-key <key>]

すべての動詞は --folder-key <key> も受け入れます (フォルダー スコープのチョイス セットの場合はフォルダー GUID)。

uip df チョイス セット

UIP DF チョイス セット リスト

チョイス セットのリストを表示します。既定ではテナント レベルのチョイス セットです。スコープを 1 つのフォルダーに --folder-key すると、すべてのフォルダーのチョイス セット --include-folders テナント レベルのチョイス セットが含まれます。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--folder-key	キー	—	フォルダー キー (GUID) - コンポーネントのスコープを特定のフォルダーに設定します。--include-foldersと相互に排他的です。
—	--include-folders	フラグ	無効	テナント レベルのチョイス セットと、表示されているすべてのフォルダーのチョイス セットを表示します。--folder-keyと相互に排他的です。

例

uip df choice-sets list

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

{
  "Code": "ChoiceSetList",
  "Data": [
    {
      "id": "c1d2e3f4-0000-0000-0000-000000000001",
      "name": "ExpenseTypes",
      "displayName": "Expense Types",
      "description": "Categories of expenses",
      "folderId": "f1000000-0000-0000-0000-000000000001",
      "createdBy": "u1000000-0000-0000-0000-000000000001",
      "updatedBy": "u1000000-0000-0000-0000-000000000001",
      "createdTime": "2026-01-01T00:00:00Z",
      "updatedTime": "2026-01-02T00:00:00Z"
    }
  ]
}

Data 行は生のキャメルケース SDK オブジェクトです。各行のidは、CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE エンティティ フィールドにchoiceSetIdとして渡す値、または以下のエンティティ フィールドに渡す値list-valuesです。

uip df チョイス セット list-values

チョイス セットの値を一覧表示する。カーソルベースのページネーションがサポートされています。

引数

名前	Required	目的
<choice-set-id>	○	チョイス セット ID (UUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-l	--limit	Number	50	ページあたりに返される値の数です。
-o	--offset	Number	—	このレコード索引を含むページから開始します (ページ境界に切り捨て)。--cursorと相互に排他的です。
—	--cursor	カーソル	—	前の回答の nextCursor.valueから取得したページネーションのカーソル値です。
—	--folder-key	キー	—	チョイス セットを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のチョイス セットの場合)。

例

uip df choice-sets list-values c1d2e3f4-0000-0000-0000-000000000001 --limit 2

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

{
  "Code": "ChoiceSetValues",
  "Data": {
    "items": [
      { "id": "v1000000-0000-0000-0000-000000000001", "name": "travel", "displayName": "Travel", "numberId": 0 },
      { "id": "v1000000-0000-0000-0000-000000000002", "name": "meals", "displayName": "Meals", "numberId": 1 }
    ],
    "totalCount": 2,
    "hasNextPage": false
  }
}

numberIdは、レコードを フィールドに挿入または更新するときに渡す整数ですCHOICE_SET_SINGLE CHOICE_SET_MULTIPLE( の場合は配列 。

uip df チョイス セット 作成

新しいチョイス セットを作成します。

引数

名前	Required	目的
<name>	○	チョイス セット名 (文字で始まり、文字、数字、アンダースコアのみ)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--display-name	text	—	人間が判読できる表示名。
—	--description	text	—	チョイス セットの説明。
—	--folder-key	UUID	—	チョイス セットを配置するフォルダーです。既定ではテナント レベルのフォルダーです。

例

uip df choice-sets create ExpenseTypes \
    --display-name "Expense Types" \
    --description "Categories of expenses"

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

{
  "Code": "ChoiceSetCreated",
  "Data": { "ID": "c1d2e3f4-0000-0000-0000-000000000001" }
}

返されたIDは、CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLEエンティティ フィールドのchoiceSetIdとして使用されます。下の choice-set-values createを使用して値を追加します。

UIP DF チョイス セットの更新

チョイス セットの表示名と説明を更新します。

引数

名前	Required	目的
<choice-set-id>	○	チョイス セット ID (UUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--display-name	text	—	必須。新しい表示名。
—	--description	text	—	必須。新しい説明。
—	--folder-key	キー	—	チョイス セットを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のチョイス セットの場合)。

重要:

--display-name と --description の両方を一緒に渡す必要があります。部分的な更新はありません。サーバーは、説明のみの更新を DisplayName is required.で拒否し、表示名のみの更新を内部サーバー エラーで拒否します。一方のフィールドのみを変更するには、まずもう一方のフィールドの現在値を choice-sets listで読み取ってから、両方を再送信します。

例

uip df choice-sets update c1d2e3f4-0000-0000-0000-000000000001 \
    --display-name "Expense Categories" \
    --description "Categories of expenses"

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

{
  "Code": "ChoiceSetUpdated",
  "Data": { "ID": "c1d2e3f4-0000-0000-0000-000000000001" }
}

UIP DF チョイス セットの削除

チョイス セットを完全に削除する。これは元に 戻せません。

引数

名前	Required	目的
<choice-set-id>	○	チョイス セット ID (UUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-y	--yes	フラグ	—	必須。これは元に戻せない操作であることを確認します。
—	--reason	text	—	必須。削除の理由 — 呼び出し元がログに記録できるように応答でエコーバックされます。
—	--folder-key	キー	—	チョイス セットを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のチョイス セットの場合)。

例

uip df choice-sets delete c1d2e3f4-0000-0000-0000-000000000001 \
    --yes --reason "no longer used"

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

{
  "Code": "ChoiceSetDeleted",
  "Data": {
    "ID": "c1d2e3f4-0000-0000-0000-000000000001",
    "Reason": "no longer used"
  }
}

uip df チョイス セット値

uip df choice-set-values 作成

チョイス セットに値を追加します。

引数

名前	Required	目的
<choice-set-id>	○	チョイス セット ID (UUID)。
<name>	○	値の名前です (文字で始まり、文字と数字のみ)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--display-name	text	—	人間が判読できる表示名。
—	--folder-key	キー	—	チョイス セットを含むフォルダーのフォルダー キー (GUID)。チョイス セットがフォルダー範囲の場合に必要です。

例

uip df choice-set-values create c1d2e3f4-0000-0000-0000-000000000001 travel \
    --display-name "Travel"

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

{
  "Code": "ChoiceSetValueCreated",
  "Data": {
    "id": "v1000000-0000-0000-0000-000000000001",
    "name": "travel",
    "displayName": "Travel",
    "numberId": 0
  }
}

返される numberId は、レコードを CHOICE_SET_SINGLE フィールド (または配列、 CHOICE_SET_MULTIPLEの場合は ) に挿入または更新するときに渡す整数です。

uip df choice-set-values の更新

既存のチョイス セットの値の表示名を更新します。

引数

名前	Required	目的
<choice-set-id>	○	チョイス セット ID (UUID)。
<value-id>	○	チョイス セット値 ID (UUID)。choice-sets list-values <choice-set-id>で検索する
<display-name>	○	値の新しい表示名です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--folder-key	キー	—	チョイス セットを含むフォルダーのフォルダー キー (GUID)。チョイス セットがフォルダー範囲の場合に必要です。

例

uip df choice-set-values update c1d2e3f4-0000-0000-0000-000000000001 \
    v1000000-0000-0000-0000-000000000001 "Business Travel"

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

{
  "Code": "ChoiceSetValueUpdated",
  "Data": {
    "id": "v1000000-0000-0000-0000-000000000001",
    "name": "travel",
    "displayName": "Business Travel",
    "numberId": 0
  }
}

uip df choice-set-values の削除

チョイス セットから 1 つ以上の値を削除します。これは元に 戻せません。

引数

名前	Required	目的
<choice-set-id>	○	チョイス セット ID (UUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--ids	id、id,...	—	必須。削除する値 ID のコンマ区切りのリストです。
-y	--yes	フラグ	—	必須。これは元に戻せない操作であることを確認します。
—	--reason	text	—	必須。削除の理由 — 呼び出し元がログに記録できるように応答でエコーバックされます。
—	--folder-key	キー	—	チョイス セットを含むフォルダーのフォルダー キー (GUID)。チョイス セットがフォルダー範囲の場合に必要です。

例

uip df choice-set-values delete c1d2e3f4-0000-0000-0000-000000000001 \
    --ids v1000000-0000-0000-0000-000000000001,v1000000-0000-0000-0000-000000000002 \
    --yes --reason "deprecated categories"

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

{
  "Code": "ChoiceSetValuesDeleted",
  "Data": {
    "ChoiceSetId": "c1d2e3f4-0000-0000-0000-000000000001",
    "DeletedIds": [
      "v1000000-0000-0000-0000-000000000001",
      "v1000000-0000-0000-0000-000000000002"
    ],
    "Reason": "deprecated categories"
  }
}

関連

• uip df entities — CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE フィールドは、choiceSetIdによって設定されたチョイスを参照します。
• uip df records — チョイス値の numberIdを使用してレコード値を挿入/更新します。

参照

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