自定义字段

需求与系统门户中的自定义字段 - API 文档

简介

在 Requirements & Systems Portal 中，自定义字段提供了一种扩展平台功能的强大方法，允许用户创建与需求和测试运行相关的附加字段。这些字段可以存储各种类型的数据，如日期、文本和选择。本 API 文档概述了以编程方式创建、更新和管理自定义字段及其选项的过程。

自定义字段的定义

需求与系统门户中的自定义字段可使用 /data/custom-field/端点创建自定义字段，语法如下：

自定义字段{
  "项目"：[uniqueItems: true integer]、
  "target_content_type"：整数、
  "name": string、
  "类型"：整数
  多"：布尔
}

• projects:自定义字段所在的项目唯一标识符列表。

• target_content_type:自定义字段的目标内容类型。120 用于需求，291 用于测试运行。

• name:自定义字段的名称。

• type:文本用 0，选择用 1，日期用 2。

• multi:定义 "选择 "类型时，设置为 "true "表示多选。

创建自定义字段

要创建自定义字段，请使用端点的 PUT 方法 /data/custom-field/.例如

{
  "项目"：[136],
  "target_content_type"：120,
  "名称"："新选择列"、
  "类型"：1
}

自定义字段选项的定义

创建选择类型的自定义字段时，还必须使用 /data/custom-field-options/端点定义可用选项：

自定义字段选项
  "custom_field"：整数、
  "titlename"：字符串、
  "位置"：数字
}

• custom_field:创建选项的自定义字段的唯一标识符。

• titlename:选项名称。

• position:可选字段，用于定义选项在选项列表中的位置。

创建自定义字段选项

要创建自定义字段选项，请使用端点的 PUT 方法 /data/custom-field-options/.例如

{
  "custom_field"：58,
  "名称"："新选项"
}

向自定义字段添加数据

要向自定义字段添加数据，请使用 /data/custom-field-row/端点，并使用以下模型：

自定义字段行{
  "referenced_object_id"：整数、
  "custom_field"：整数、
  值"：字符串
}

• referenced_object_id:数据所属对象（需求或测试运行）的唯一标识符。

• custom_field:要添加数据的自定义字段的唯一标识符。

• value:要添加的数据。对于文本，使用自由文本字符串；对于单选，使用选项 id；对于多选，使用选项 id 列表；对于日期，使用字符串格式的日期。

向自定义字段添加数据 - 首次输入

首次向给定对象的自定义字段输入数据时，请使用端点的 POST 方法 /data/custom-field-row/bulk-create/.例如

{
  "referenced_object_id"：33803,
  "custom_field"：58,
  "value": 29
}

更新自定义字段中的数据

要更新给定对象自定义字段的现有数据，请使用端点的 POST 方法 /data/custom-field-row/bulk-update/.例如

{
  "614":{
    "value": 30
  }
}

从自定义字段中删除数据

要删除与给定自定义字段和对象相关联的数据，请使用与批量更新方法相同的 "value": null.例如

{
  "614":{
    "value": null
  }
}

结论

Requirements & Systems Portal 中的自定义字段可让您增强平台的功能，使其满足您的特定项目需求。通过使用提供的 API 端点，您可以创建自定义字段、定义选项并以编程方式添加数据，从而使 Requirements & Systems Portal 成为满足项目管理和分析需求的多功能工具。