Aggiunta e gestione di un'intestazione

Definire una o più intestazioni da passare alla sezione dell'intestazione della richiesta REST. Un'intestazione ha una chiave e un valore. Sono supportate tutte le intestazioni di richiesta API REST standard.

Ad esempio, è possibile aggiungere l'intestazione Content-Type per una richiesta POST o PUT.

È possibile utilizzare le procedure riportate di seguito per aggiungere e gestire le intestazioni nell'URL HTTP principale o nell'URL di polling e nell'URL di interruzione facoltativi.

Creazione intestazione

Creare un'intestazione di richiesta per il metodo HTTP principale o i metodi HTTP di polling e interruzione facoltativi.

Per creare un'intestazione:

  1. Nel passo Definisci dettagli esecuzione della pagina Configura dettagli API REST, selezionare Intestazione per creare un'intestazione per il task REST.

    Per creare un'intestazione per l'URL di polling o interruzione, andare alla pagina Specifica criteri di completamento, selezionare la casella di controllo Configura una condizione di polling e interruzione per una chiamata REST senza attesa. Nella scheda Polling o Cessazione, selezionare Intestazione.

  2. Fare clic su Aggiungi intestazione.
  3. Nel campo Chiave iniziare a digitare il nome di un'intestazione.
    Quando viene trovato un tasto corrispondente, viene visualizzato un elenco di suggerimenti in un menu. Selezionare l'intestazione desiderata.
  4. Nel campo Valore, iniziare a digitare il nome del valore dell'intestazione.
    Quando viene trovato un valore corrispondente, viene visualizzato un elenco di suggerimenti in un menu. Selezionare il valore di intestazione desiderato.
  5. Fare clic su Aggiungi.

    La chiave e il valore dell'intestazione vengono aggiunti alla tabella Intestazione.

    Per assegnare un parametro per il valore della coppia chiave-valore di intestazione, fare clic su Esponi come parametro di task. Vedere Parametrizzazione di un valore di intestazione.

Modifica di un'intestazione

È possibile modificare la chiave e il valore di un'intestazione.

Se il valore dell'intestazione è parametrizzato, modificare il parametro per modificare il valore del parametro predefinito. Vedere Modifica del valore di un'intestazione con parametri.

Per modificare una coppia chiave-valore intestazione:

  1. Nel passo Definisci dettagli esecuzione della pagina Configura dettagli API REST, selezionare Intestazione per modificare un'intestazione nel task REST.

    Per modificare un'intestazione per l'URL di polling o interruzione, andare alla pagina Specifica criteri di completamento. Nella scheda Polling o Cessazione, selezionare Intestazione.

  2. Nella riga della tabella relativa a un'intestazione, selezionare Modifica dal menu Azioni (Menu Azioni).
  3. Nel pannello Modifica intestazione modificare i valori nei campi Chiave e Valore, quindi fare clic su Salva.

    Quando si inizia a digitare uno dei due campi, viene visualizzato un elenco di suggerimenti in un menu quando viene trovato un elemento corrispondente. È quindi possibile selezionare la chiave di intestazione o il valore di intestazione desiderato.

    Nota

    Se il valore nel campo Valore è una stringa di parametri, ad esempio ${PARAMETER_HEADER}, e la stringa viene sovrascritta con un valore di intestazione corrispondente alla chiave, il parametro viene rimosso quando si fa clic su Salva. Per parametrizzare di nuovo il valore dell'intestazione, fare clic su Esponi come parametro di task, come descritto in Parametrizzazione di un valore di intestazione.

Eliminazione di un'intestazione

L'eliminazione di un'intestazione rimuove la coppia chiave-valore dell'intestazione dal task REST.

Per eliminare un'intestazione:

  1. Nel passo Definisci dettagli esecuzione della pagina Configura dettagli API REST, selezionare Intestazione per eliminare un'intestazione nel task REST.

    Per eliminare un'intestazione per l'URL di polling o interruzione, andare alla pagina Specifica criteri di completamento. Nella scheda Polling o Cessazione, selezionare Intestazione.

  2. Nella riga della tabella relativa a un'intestazione, selezionare Elimina dal menu Azioni (Menu Azioni).
  3. Nella finestra di dialogo Elimina intestazione fare clic su Elimina.

    La coppia chiave-valore intestazione viene rimossa dalla tabella Intestazione.

    Nota

    Se il valore dell'intestazione è stato parametrizzato, il parametro associato al valore dell'intestazione non viene eliminato. Per eliminare il parametro, vedere Eliminazione di un parametro di task REST.
Parametrizzazione di un valore di intestazione

Dopo aver definito la coppia chiave-valore per un'intestazione, è possibile assegnare un parametro task al valore dell'intestazione.

Per parametrizzare il valore di intestazione di un'intestazione:

  1. Nel passo Definisci dettagli esecuzione della pagina Configura dettagli API REST, selezionare Intestazione.

    Per parametrizzare un valore di intestazione per l'URL di polling o interruzione, andare alla pagina Specifica criteri di completamento. Nella scheda Polling o Cessazione, selezionare Intestazione.

  2. Nella riga della tabella relativa a un'intestazione, accanto al valore dell'intestazione, fare clic su Esponi come parametro task.
  3. Nel pannello Aggiungi parametro, immettere un nome per il parametro nel campo Identificativo oppure utilizzare il valore predefinito.

    Il nome del parametro deve essere univoco nel task REST. Per un elenco corrente dei parametri nel task, vedere Visualizzazione di tutti i parametri in un task REST.

  4. (Facoltativo) Immettere una descrizione per facilitare l'identificazione dello scopo del parametro per gli altri utenti.
  5. Il tipo di dati è String. Impossibile modificare il tipo di dati.
  6. Impostare la lunghezza.
  7. Impostare il valore predefinito per il parametro.
    Il valore di intestazione predefinito viene utilizzato in runtime, a meno che non si modifichi il valore in fase di progettazione o runtime.
  8. Fare clic su Aggiungi.
    La riga della tabella dell'intestazione viene aggiornata con il nome del parametro accanto al valore dell'intestazione.
Modifica del valore di un'intestazione parametrizzata

È possibile modificare solo il valore predefinito del parametro.

Per modificare il valore predefinito per un valore di intestazione con parametri:

  1. Nel passo Definisci dettagli esecuzione della pagina Configura dettagli API REST, selezionare Intestazione.

    Per modificare un valore di intestazione con parametri per l'URL di polling o interruzione, andare alla pagina Specifica criteri di completamento. Nella scheda Polling o Cessazione, selezionare Intestazione.

  2. Nella riga della tabella relativa al valore di intestazione che si desidera modificare, accanto al nome del parametro fare clic su Modifica parametro.
  3. Nel pannello Modifica parametro, modificare il valore del parametro.
  4. Fare clic su Salva.
Rimozione di un parametro valore intestazione

La rimozione di un parametro del valore di intestazione rimuove solo l'associazione del parametro al valore di intestazione dell'intestazione.

La rimozione del parametro del valore dell'intestazione non elimina la coppia chiave-valore dell'intestazione.

Per rimuovere un parametro del valore di intestazione, procedere come segue.

  1. Nel passo Definisci dettagli esecuzione della pagina Configura dettagli API REST, selezionare Intestazione.

    Per rimuovere un parametro del valore di intestazione per l'URL di polling o interruzione, andare alla pagina Specifica criteri di completamento. Nella scheda Polling o Cessazione, selezionare Intestazione.

  2. Nella riga della tabella relativa al parametro del valore di intestazione che si desidera rimuovere, fare clic su Rimuovi parametro.
  3. Nella finestra di dialogo Rimuovi parametro, fare clic su Rimuovi.

    L'assegnazione del parametro al valore di intestazione dell'intestazione è stata annullata. Il valore assegnato al parametro diventa il valore di intestazione.

    Nota

    Il parametro del valore dell'intestazione non viene eliminato dal task REST. Per eliminare il parametro, vedere Eliminazione di un parametro di task REST.