Fornitura di un corpo della richiesta

Fornire il corpo della richiesta richiesto per una richiesta REST utilizzando il metodo POST o PUT.

Le procedure riportate di seguito possono essere utilizzate per configurare un corpo della richiesta nell'URL HTTP principale o nell'URL di polling e nell'URL di interruzione facoltativi.

Aggiunta del corpo della richiesta

Attualmente, solo JSON è il formato supportato per un corpo della richiesta.

Per creare un corpo della richiesta:

  1. Nel passo Definisci dettagli esecuzione della pagina Configura dettagli API REST, selezionare Richiesta per creare un corpo della richiesta per il task REST.

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

    Se la scheda Richiesta non è visibile, assicurarsi di aver selezionato il metodo HTTP appropriato.

  2. Nell'editor immettere il corpo della richiesta.
    • È possibile digitare o copiare e incollare l'intero payload.

    • È possibile fare riferimento ai parametri esistenti nel payload utilizzando la sintassi ${}. Ad esempio:

      {
          "modelType": "USER_PROJECT",
          "modelVersion": "20200901",
          "parentRef": {},
          "name": "${PROJECT_NAME}",
          "identifier": "${PROJECT_NAME}",
          "description": "Creating my project",
          "objectVersion": 0,
          "objectStatus": 8,
          "registryMetadata": {
              "registryVersion": 0
          }
      }
    Nota

    Il programma di convalida incorporato nell'editor convalida il corpo della richiesta. Se viene visualizzato un punto rosso con una 'x' sul lato dell'editor, passare il puntatore del mouse sull'icona per visualizzare l'errore per quella riga di codice.
  3. Per assegnare un parametro di task all'intero corpo della richiesta, fare clic su Esponi come parametro di task. Vedere Parametrizzazione del corpo della richiesta.

    Per modificare il corpo di un corpo di richiesta con parametri, modificare il valore del parametro.

Parametrizzazione del corpo della richiesta

Oltre a utilizzare i parametri all'interno del corpo della richiesta, è possibile parametrizzare l'intero corpo della richiesta.

Vedere Aggiunta del corpo della richiesta.

Dopo aver creato il corpo della richiesta nell'editor, è possibile assegnare un parametro del task all'intero corpo.

Per parametrizzare l'intero corpo della richiesta:

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

    Per parametrizzare il corpo della richiesta per un URL di polling o interruzione, andare alla pagina Specifica criteri di completamento. Nella scheda Polling o Cessazione, selezionare Richiesta.

  2. Fare clic su Esponi come parametro task.

    Se non è stato ancora immesso il corpo della richiesta, Data Integration visualizza un messaggio di avvertenza in una finestra di dialogo. Immettere prima un corpo della richiesta, quindi assegnare un parametro all'intero corpo.

  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 del parametro è JSON, che non è possibile modificare.
  6. Nel campo Valore impostare la notazione JSON predefinita per questo parametro del task.
  7. Fare clic su Aggiungi.
    Il nome del parametro viene aggiunto alla parte superiore dell'editor.

Per modificare il corpo di un corpo di richiesta con parametri, modificare il valore del parametro.

Modifica del valore di un parametro del corpo della richiesta

È possibile modificare il valore predefinito del parametro del task per il corpo della richiesta.

Per modificare il corpo della richiesta con parametri:

  1. Nel passo Definisci dettagli esecuzione della pagina Configura dettagli API REST di un metodo POST o PUT, selezionare Richiesta.

    Per modificare il corpo della richiesta con parametri per un URL di polling o interruzione, andare alla pagina Specifica criteri di completamento. Nella scheda Polling o Cessazione, selezionare Richiesta.

  2. Fare clic su Modifica parametro.
  3. Nel pannello Modifica parametri è possibile modificare solo il campo Valore. Impossibile modificare il tipo di dati o la descrizione.

    Per modificare la descrizione, vedere Modifica di un parametro di task REST.

  4. Fare clic su Salva.
Rimozione del parametro del corpo della richiesta

La rimozione del parametro comporta la rimozione solo dell'associazione del parametro al corpo della richiesta nel task REST.

Per annullare l'assegnazione del parametro dall'intero corpo della richiesta, effettuare le operazioni riportate di seguito.

  1. Nel passo Definisci dettagli esecuzione della pagina Configura dettagli API REST di un metodo POST o PUT, selezionare Richiesta.

    Per annullare l'assegnazione del parametro dal corpo della richiesta per un URL di polling o interruzione, andare alla pagina Specifica criteri di completamento. Nella scheda Polling o Cessazione, selezionare Richiesta.

  2. Fare clic su Rimuovi parametro.
  3. Nella finestra di dialogo Rimuovi parametro, fare clic su Rimuovi.

    L'assegnazione del parametro al corpo della richiesta è stata annullata. Il corpo della richiesta assegnato al parametro diventa il corpo della richiesta predefinito.

    Nota

    Il parametro non viene eliminato dal task REST. Per eliminare il parametro, vedere Eliminazione di un parametro di task REST.