Campos personalizados

Campos personalizados en Requirements & Systems Portal - Documentación de la API

Introducción

En Requirements & Systems Portal, los campos personalizados ofrecen una forma eficaz de ampliar la funcionalidad de la plataforma al permitir a los usuarios crear campos adicionales asociados con requisitos y ejecuciones de prueba. Estos campos pueden almacenar varios tipos de datos, como fechas, texto y selecciones. Esta documentación de la API describe el proceso para crear, actualizar y gestionar campos personalizados y sus opciones de forma programática.

Definición de campos personalizados

Los campos personalizados en Requirements & Systems Portal se pueden crear mediante el endpoint /data/custom-field/ con la siguiente sintaxis:

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

• projects: Lista de identificadores únicos de proyecto donde el campo personalizado debe estar disponible.

• target_content_type: El tipo de contenido de destino para el campo personalizado. Use 120 para requisitos y 291 para ejecuciones de prueba.

• name: El nombre del campo personalizado.

• type: Use 0 para Texto, 1 para Selección y 2 para Fecha.

• multi: Establézcalo en true para selección múltiple al definir un tipo Selección.

Creación de campos personalizados

Para crear un campo personalizado, use el método PUT para el endpoint /data/custom-field/. Por ejemplo:

{
  "projects": [136],
  "target_content_type": 120,
  "name": "New Selection Column",
  "type": 1
}

Definición de opciones de campos personalizados

Al crear campos personalizados de tipo Selección, también debe definir las opciones disponibles mediante el endpoint /data/custom-field-options/ con el siguiente modelo:

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

• custom_field: El identificador único del campo personalizado para el que se está creando la opción.

• titlename: El nombre de la opción.

• position: Campo opcional para definir la posición de la opción en la lista de opciones.

Creación de opciones de campos personalizados

Para crear una opción de campo personalizado, use el método PUT para el endpoint /data/custom-field-options/. Por ejemplo:

{
  "custom_field": 58,
  "name": "New Option"
}

Adición de datos a campos personalizados

Para agregar datos a un campo personalizado, use el endpoint /data/custom-field-row/ con el siguiente modelo:

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

• referenced_object_id: El identificador único del objeto (requisito o ejecución de prueba) al que pertenecen los datos.

• custom_field: El identificador único del campo personalizado al que se están agregando los datos.

• value: Los datos que se van a agregar. Para Texto, use una cadena de texto libre; para Selección única, use un id de opción; para Selección múltiple, use una lista de ids de opción; para Fecha, use una fecha en formato de cadena.

Adición de datos a campos personalizados - Primera entrada

Para la primera carga de datos en un campo personalizado de un objeto determinado, use el método POST para el endpoint /data/custom-field-row/bulk-create/. Por ejemplo:

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

Actualización de datos en campos personalizados

Para actualizar datos existentes de un campo personalizado de un objeto determinado, use el método POST para el endpoint /data/custom-field-row/bulk-update/. Por ejemplo:

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

Eliminación de datos de campos personalizados

Para eliminar datos asociados con un campo personalizado y un objeto determinados, use el mismo método de actualización masiva con "value": null. Por ejemplo:

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

Conclusión

Los campos personalizados en Requirements & Systems Portal le permiten mejorar las capacidades de la plataforma y adaptarla a las necesidades específicas de su proyecto. Al usar los endpoints de la API proporcionados, puede crear campos personalizados, definir opciones y agregar datos de forma programática, lo que convierte a Requirements & Systems Portal en una herramienta versátil para la gestión y el análisis de proyectos.