Campos personalizados

Campos Personalizados no Requirements & Systems Portal - Documentação da API

Introdução

No Requirements & Systems Portal, os Campos Personalizados oferecem uma forma poderosa de expandir a funcionalidade da plataforma, permitindo aos utilizadores criar campos adicionais associados a requisitos e execuções de teste. Estes campos podem armazenar vários tipos de dados, como datas, texto e seleções. Esta documentação da API descreve o processo de criação, atualização e gestão programática de Campos Personalizados e das respetivas opções.

Definição de Campos Personalizados

Os Campos Personalizados no Requirements & Systems Portal podem ser criados utilizando o endpoint /data/custom-field/ com a seguinte sintaxe:

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

• projects: Lista de identificadores únicos de projeto onde o Campo Personalizado deverá estar disponível.

• target_content_type: O tipo de conteúdo de destino para o Campo Personalizado. Utilize 120 para requisitos e 291 para execuções de teste.

• name: O nome do Campo Personalizado.

• type: Utilize 0 para Texto, 1 para Seleção e 2 para Data.

• multi: Defina como true para seleção múltipla ao definir um tipo Seleção.

Criação de Campos Personalizados

Para criar um Campo Personalizado, utilize o método PUT para o endpoint /data/custom-field/. Por exemplo:

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

Definição das Opções de Campo Personalizado

Ao criar Campos Personalizados do tipo Seleção, também tem de definir as opções disponíveis utilizando o endpoint /data/custom-field-options/ com o seguinte modelo:

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

• custom_field: O identificador único do Campo Personalizado para o qual a opção está a ser criada.

• titlename: O nome da opção.

• position: Campo opcional para definir a posição da opção na lista de opções.

Criação de Opções de Campo Personalizado

Para criar uma Opção de Campo Personalizado, utilize o método PUT para o endpoint /data/custom-field-options/. Por exemplo:

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

Adicionar Dados a Campos Personalizados

Para adicionar dados a um Campo Personalizado, utilize o endpoint /data/custom-field-row/ com o seguinte modelo:

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

• referenced_object_id: O identificador único do objeto (requisito ou execução de teste) ao qual os dados pertencem.

• custom_field: O identificador único do Campo Personalizado ao qual os dados estão a ser adicionados.

• value: Os dados a adicionar. Para Texto, utilize uma cadeia de texto livre; para Seleção Única, utilize um ID de opção; para Seleção Múltipla, utilize uma lista de IDs de opção; para Data, utilize uma data em formato de cadeia de texto.

Adicionar Dados a Campos Personalizados - Primeira Introdução

Para a primeira introdução de dados num Campo Personalizado de um determinado objeto, utilize o método POST para o endpoint /data/custom-field-row/bulk-create/. Por exemplo:

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

Atualização de Dados em Campos Personalizados

Para atualizar dados existentes de um Campo Personalizado de um determinado objeto, utilize o método POST para o endpoint /data/custom-field-row/bulk-update/. Por exemplo:

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

Remoção de Dados de Campos Personalizados

Para remover dados associados a um determinado Campo Personalizado e objeto, utilize o mesmo método de atualização em massa com "value": null. Por exemplo:

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

Conclusão

Os Campos Personalizados no Requirements & Systems Portal permitem melhorar as capacidades da plataforma e adaptá-la às necessidades específicas do seu projeto. Ao utilizar os endpoints da API fornecidos, pode criar Campos Personalizados, definir opções e adicionar dados programaticamente, tornando o Requirements & Systems Portal uma ferramenta versátil para os seus requisitos de gestão e análise de projetos.