Campi personalizzati

Campi personalizzati in Requirements & Systems Portal - Documentazione API

Introduzione

In Requirements & Systems Portal, i campi personalizzati offrono un modo efficace per estendere le funzionalità della piattaforma, consentendo agli utenti di creare campi aggiuntivi associati ai requisiti e alle esecuzioni di test. Questi campi possono memorizzare vari tipi di dati, come date, testo e selezioni. Questa documentazione API descrive il processo per creare, aggiornare e gestire i campi personalizzati e le relative opzioni a livello di codice.

Definizione dei campi personalizzati

I campi personalizzati in Requirements & Systems Portal possono essere creati utilizzando l'endpoint /data/custom-field/ con la seguente sintassi:

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

• projects: Elenco degli identificatori univoci dei progetti in cui il campo personalizzato deve essere disponibile.

• target_content_type: Il tipo di contenuto di destinazione per il campo personalizzato. Utilizzare 120 per i requisiti e 291 per le esecuzioni di test.

• name: Il nome del campo personalizzato.

• type: Utilizzare 0 per Testo, 1 per Selezione e 2 per Data.

• multi: Impostare su true per la selezione multipla quando si definisce un tipo Selezione.

Creazione dei campi personalizzati

Per creare un campo personalizzato, utilizzare il metodo PUT per l'endpoint /data/custom-field/. Ad esempio:

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

Definizione delle opzioni del campo personalizzato

Quando si creano campi personalizzati di tipo Selezione, è necessario definire anche le opzioni disponibili utilizzando l'endpoint /data/custom-field-options/ con il seguente modello:

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

• custom_field: L'identificatore univoco del campo personalizzato per cui viene creata l'opzione.

• titlename: Il nome dell'opzione.

• position: Campo facoltativo per definire la posizione dell'opzione nell'elenco delle opzioni.

Creazione delle opzioni del campo personalizzato

Per creare un'opzione del campo personalizzato, utilizzare il metodo PUT per l'endpoint /data/custom-field-options/. Ad esempio:

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

Aggiunta di dati ai campi personalizzati

Per aggiungere dati a un campo personalizzato, utilizzare l'endpoint /data/custom-field-row/ con il seguente modello:

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

• referenced_object_id: L'identificatore univoco dell'oggetto (requisito o esecuzione di test) a cui appartengono i dati.

• custom_field: L'identificatore univoco del campo personalizzato a cui vengono aggiunti i dati.

• value: I dati da aggiungere. Per Testo, utilizzare una stringa di testo libero; per Selezione singola, utilizzare un ID opzione; per Selezione multipla, utilizzare un elenco di ID opzione; per Data, utilizzare una data in formato stringa.

Aggiunta di dati ai campi personalizzati - Primo inserimento

Per il primo inserimento di dati in un campo personalizzato di un determinato oggetto, utilizzare il metodo POST per l'endpoint /data/custom-field-row/bulk-create/. Ad esempio:

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

Aggiornamento dei dati nei campi personalizzati

Per aggiornare i dati esistenti di un campo personalizzato di un determinato oggetto, utilizzare il metodo POST per l'endpoint /data/custom-field-row/bulk-update/. Ad esempio:

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

Rimozione dei dati dai campi personalizzati

Per rimuovere i dati associati a un determinato campo personalizzato e oggetto, utilizzare lo stesso metodo di aggiornamento in blocco con "value": null. Ad esempio:

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

Conclusione

I campi personalizzati in Requirements & Systems Portal consentono di ampliare le capacità della piattaforma e adattarla alle esigenze specifiche del progetto. Utilizzando gli endpoint API forniti, è possibile creare campi personalizzati, definire opzioni e aggiungere dati a livello di codice, rendendo Requirements & Systems Portal uno strumento versatile per le esigenze di gestione e analisi del progetto.