uip df 选项集

“uip df choice-sets”和“uip df choice-set-values”的语法和选项，用于管理 Data Fabric 的枚举值列表。

uip df choice-sets和uip df choice-set-values管理 Data 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 选项设置列表

列出选项集。默认为租户级别选项集； --folder-key 限定一个文件夹，--include-folders 限定每个文件夹的选项集以及租户级别的选项集。

选项

短	长	值	默认	描述
—	--folder-key	键值	—	用于将列表的范围限定到特定文件夹的文件夹键值 (GUID)。与 --include-folders 互斥。
—	--include-folders	标记	关闭	列出租户级别的选项集以及您可以看到的每个文件夹中的选项集。与 --folder-key 互斥。

示例

uip df choice-sets list

数据形状（--输出 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都是要作为choiceSetId上的CHOICE_SET_SINGLE / CHOICE_SET_MULTIPLE传递给下方的list-values值。

uip df 选项设置列表值

列出选项集的值。支持基于光标的分页。

参数

名称	必填	用途
<choice-set-id>	是	选项集 ID (UUID)。

选项

短	长	值	默认	描述
-l	--limit	数字	50	每页要返回的值的数量。
-o	--offset	数字	—	从包含此记录索引的页面开始（向下舍入到页面边界）。与--cursor互斥。
—	--cursor	光标	—	上一个响应的 nextCursor.value 中的分页光标值。
—	--folder-key	键值	—	对于文件夹范围的选项集，包含选项集的文件夹的文件夹密钥 (GUID)。

示例

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

数据形状（--输出 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 选项集创建

创建新选项集。

参数

名称	必填	用途
<name>	是	选项集名称（以字母开头；仅限字母、数字和下划线）。

选项

短	长	值	默认	描述
—	--display-name	text	—	人类可读的显示名称。
—	--description	text	—	选项集说明。
—	--folder-key	UUID	—	用于放置选项集的文件夹。默认为租户级文件夹。

示例

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

数据形状（--输出 json）

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

返回的 ID 用作 choiceSetId/CHOICE_SET_SINGLE 实体字段的 CHOICE_SET_MULTIPLE。使用下面的 choice-set-values create 添加值。

uip df 选项集更新

更新选项集的显示名称和描述。

参数

名称	必填	用途
<choice-set-id>	是	选项集 ID (UUID)。

选项

短	长	值	默认	描述
—	--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"

数据形状（--输出 json）

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

uip df 选项集删除

完全删除选项集。此操作无法撤销。

参数

名称	必填	用途
<choice-set-id>	是	选项集 ID (UUID)。

选项

短	长	值	默认	描述
-y	--yes	标记	—	必需。确认这是一个不可逆的操作。
—	--reason	text	—	必需。删除原因 — 在响应中回显，以便调用者可以记录。
—	--folder-key	键值	—	对于文件夹范围的选项集，包含选项集的文件夹的文件夹密钥 (GUID)。

示例

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

数据形状（--输出 json）

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

uip df 选项集值

uip df 选择设置值创建

向选项集添加值。

参数

名称	必填	用途
<choice-set-id>	是	选项集 ID (UUID)。
<name>	是	值名称（以字母开头；仅限字母和数字）。

选项

短	长	值	默认	描述
—	--display-name	text	—	人类可读的显示名称。
—	--folder-key	键值	—	包含选项集的文件夹的文件夹密钥 (GUID)。当选项集是文件夹范围时为必填项。

示例

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

数据形状（--输出 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-id>	是	选项集 ID (UUID)。
<value-id>	是	选项集值 ID (UUID)。使用 choice-sets list-values <choice-set-id> 查找。
<display-name>	是	值的新显示名称。

选项

短	长	值	默认	描述
—	--folder-key	键值	—	包含选项集的文件夹的文件夹密钥 (GUID)。当选项集是文件夹范围时为必填项。

示例

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

数据形状（--输出 json）

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

uip df 选项集值删除

从选项集中删除一个或多个值。此操作无法撤销。

参数

名称	必填	用途
<choice-set-id>	是	选项集 ID (UUID)。

选项

短	长	值	默认	描述
—	--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"

数据形状（--输出 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 工具概述
• 全局选项
• 退出代码