Пользовательские поля

Пользовательские поля в Портале требований и систем - Документация по API

Введение

В Requirements & Systems Portal настраиваемые поля обеспечивают мощный способ расширения функциональности платформы, позволяя пользователям создавать дополнительные поля, связанные с требованиями и тестовыми испытаниями. Эти поля могут хранить различные типы данных, такие как даты, текст и выборки. В этой документации по API описывается процесс создания, обновления и управления пользовательскими полями и их параметрами программным способом.

Определение пользовательских полей

Пользовательские поля в Requirements & Systems Portal можно создать с помощью конечной точки /data/custom-field/ со следующим синтаксисом:

CustomField{
  "projects": [uniqueItems: true integer],
  "target_content_type": integer,
  "name": string,
  "type": integer,
  "multi": boolean
}

• projects: Список уникальных идентификаторов проектов, в которых должно быть доступно настраиваемое поле.

• target_content_type: Целевой тип содержимого для настраиваемого поля. Используйте 120 для требований и 291 для тестовых испытаний.

• name: Имя пользовательского поля.

• type: Используйте 0 для текста, 1 для выбора и 2 для даты.

• multi: Установите значение true для мультивыбора при определении типа Selection.

Создание пользовательских полей

Чтобы создать пользовательское поле, используйте метод PUT для конечной точки /data/custom-field/. Например:

{
  "проекты": [136],
  "target_content_type": 120,
  "name": "Новая колонка выбора",
  "type": 1
}

Определение опций пользовательского поля

При создании пользовательских полей типа Selection необходимо также определить доступные опции с помощью конечной точки /data/custom-field-options/ со следующей моделью:

CustomFieldOption{
  "custom_field": integer,
  "titlename": string,
  "position": number
}

• custom_field: Уникальный идентификатор пользовательского поля, для которого создается опция.

• titlename: Имя опции.

• position: Необязательное поле для определения позиции опции в списке опций.

Создание опций пользовательского поля

Чтобы создать опцию пользовательского поля, используйте метод PUT для конечной точки /data/custom-field-options/. Например:

{
  "custom_field": 58,
  "name": "Новый вариант"
}

Добавление данных в пользовательские поля

Чтобы добавить данные в настраиваемое поле, используйте конечную точку /data/custom-field-row/ со следующей моделью:

CustomFieldRow{
  "referenced_object_id": integer,
  "custom_field": integer,
  "value": string
}

• referenced_object_id: Уникальный идентификатор объекта (требования или тестового задания), которому принадлежат данные.

• custom_field: Уникальный идентификатор пользовательского поля, в которое добавляются данные.

• value: Данные, которые необходимо добавить. Для "Текст" используйте свободную текстовую строку; для "Одиночный выбор" используйте идентификатор опции; для "Множественный выбор" используйте список идентификаторов опций; для "Дата" используйте дату в формате строки.

Добавление данных в пользовательские поля - первый ввод

Для первого ввода данных в пользовательское поле данного объекта используйте метод 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
  }
}

Удаление данных из настраиваемых полей

Чтобы удалить данные, связанные с заданным пользовательским полем и объектом, используйте тот же метод bulk-update с "value": null. Например:

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

Заключение

Пользовательские поля в Requirements & Systems Portal позволяют расширить возможности платформы и адаптировать ее к конкретным потребностям проекта. Используя предоставленные конечные точки API, вы можете создавать настраиваемые поля, определять параметры и добавлять данные программным способом, что делает Requirements & Systems Portal универсальным инструментом для управления проектами и анализа.