Collegamento di oggetti ai Servizi Web REST

È possibile aggiungere un comportamento Servizio Web REST a un oggetto utilizzando Progettazione oggetti per fornire un'ampia gamma di opzioni per l'integrazione con altre applicazioni come Ivanti Automation.

Questa è una funzione avanzata destinata all'uso da parte di persone abituate a utilizzare tecnologie come REST, JSON, Postman e Swagger. Se si desidera supporto da Ivanti Professional Services nell'utilizzo di questa funzionalità, contattare il proprio fornitore.

Prima di configurare Service Desk

Prima di iniziare a configurare il comportamento in Service Desk, raccomandiamo di usare prima strumenti come Swagger e Postman per progettare e configurare l'interazione con l'endpoint, per ottenere un supporto con qualsiasi debug necessario. Una volta testate le interazioni in questo modo, è possibile configurare Service Desk per riprodurre tali interazioni.

Raccomandiamo inoltre di progettare queste nuove parti in un'istanza di sviluppo, testarle accuratamente e poi trasferire questi progetti alla produzione, piuttosto che applicare qualsiasi nuovo contenuto direttamente all'ambiente di produzione. Per ulteriori dettagli, vedere Promozione dei design REST nei propri ambienti di produzione.

Configurazione di Service Desk

Una volta progettate e testate le proprie chiamate API RESTful al di fuori di Service Desk, riprodurre tali interazioni nelle progettazioni di Service Desk. Tenere presente che la chiamata REST viene effettuata solo quando viene creata un'istanza di un oggetto con il comportamento REST. Il nuovo aggiornamento e salvataggio dell'oggetto non invia un'altra chiamata REST.

Il primo passo è aggiungere il comportamento del servizio Web REST all'oggetto che si desidera utilizzare per integrarsi con l'endpoint.

Per aggiungere il comportamento Servizio Web REST a un oggetto:
  1. Aprire l'oggetto con cui si desidera utilizzare il servizio Web REST in Progettazione oggetti.
  2. Selezionare l'oggetto in cima all'albero Attributi, quindi nella griglia Proprietà fare clic su icona ellissi accanto a Comportamenti.
    Verrà visualizzata la finestra di dialogo Selezione comportamento.
  3. Selezionare Servizio Web REST nell'elenco Elementi disponibili, quindi fare clic su icona freccia destra.
    Servizio Web REST passa all'elenco Elementi selezionati.
  4. Fare clic su OK e salvare le modifiche.
    La finestra di dialogo Selezione comportamento si chiude e un nuovo elemento, Servizi Web REST, appare nella griglia Proprietà.
    Inoltre, quattro nuovi attributi vengono creati sull'oggetto: Corpo richiesta creazione servizio Rest, Stato creazione servizio Rest, URI richiesta creazione servizio Rest e una relazione chiamata Modello corpo richiesta creazione servizio Rest che rappresenta una relazione con un nuovo oggetto di elenco di riferimento chiamato CorpoOggetto. (In cui Oggetto è il nome dell'oggetto aggiunto al comportamento.)

    5. Sarà necessario creare finestre per qualsiasi nuovo oggetto creato.

  5. Nella griglia Proprietà, fare clic su icona ellissi accanto a Servizi Web REST.
    Appare la finestra di dialogo Servizi Web REST.
  6. Sulla scheda Richiesta, digitare l'URI per l'endpoint che si desidera usare nel campo URI End Point.

    7. È possibile includere variabili segnaposto nel campo URI end point. Ciò avviene in genere per PATCH.

  7. Selezionare POST, PATCH o DELETE in base a quanto appropriato.
    Post viene in genere utilizzato per creare elementi, mentre Patch viene utilizzato per aggiornare elementi esistenti. Se si desidera creare un elemento usando il servizio Web REST e poi aggiornare lo stesso elemento usando il servizio Web REST, sarà necessario creare due oggetti: uno per creare l'elemento usando Post e un altro per aggiornare l'elemento usando Patch.
  8. Nell'elenco a discesa Tipo contenuto, selezionare il tipo di contenuto che si sta inviando.
  9. Nell'elenco Tipo autenticazione, selezionare il tipo di autenticazione richiesto: Nessuno, Base, Chiave API (intestazione), OAuth2 (credenziali client) o OAuth2 (Password) insieme ai parametri aggiuntivi richiesti.
  10. Fare clic su OK.

Può capitare che si voglia disattivare temporaneamente il comportamento REST. È possibile farlo per un oggetto specifico rimuovendo il segno di spunta dalla casella di controllo Abilita sulla finestra di dialogo Servizi Web REST.

Se si desidera eseguire ulteriori azioni sul record creato con il servizio Web REST, sarà necessario specificare il percorso dell'identificatore univoco restituito dalla propria applicazione esterna e la posizione in Service Desk dove si desidera memorizzare queste informazioni.

Per memorizzare gli identificatori univoci:

  1. Sulla scheda Mapping risposta della finestra di dialogo Selezione comportamento, nel campo Origine inserire il percorso all'identificatore univoco restituito dalla propria applicazione esterna.
    È possibile usare la notazione a punti per identificare gli elementi nel payload sorgente. Inserire * se si desidera utilizzare l'intera risposta.
  2. Nel campo Destinazione inserire l'attributo Service Desk della stinga tipo in cui si desidera memorizzare il valore restituito in Service Desk.
    Questo avrà la forma {_Request/Field}.
  3. Nell'elenco a discesa Accetta, selezionare il tipo di contenuto che ci si aspetta di ricevere.
    Se si seleziona un formato XML, specificare gli Spazi nome XML, separando i nomi dei nomi spazio multipli con spazi. Ad esempio xmlns:h="http://www.w3.org/TR/html4/" xmlns:r="http://www.example.com/example/"
  4. Fare clic su OK.

Ora che è stato configurato il collegamento tra l'oggetto Service Desk e l'endpoint, è possibile specificare il Corpo del payload che si desidera inviare. Il carico di lavoro deve essere JSON o XML. Alcuni endpoint accettano più payload diversi. Ad esempio, Ivanti Automation fornisce un endpoint singolo che accetta i payload da più runbook con il runbook richiesto specificato nel Corpo del payload.

Ecco perché la relazione Modello corpo richiesta creazione servizio REST all'oggetto elenco di riferimento CorpoOggetto viene creata quando si aggiunge il comportamento servizio Web REST. Ciò consente di creare un elenco di riferimento (per i dettagli, vedere Creazione di nuovi elenchi di riferimento) per memorizzare i vari Corpi payload e qui, all'interno della procedura, fornire un meccanismo per l'istanza elenco di riferimento appropriata da selezionare (ad esempio utilizzando il tipo valore su un'Azione automatica; per i dettagli, vedere Specifica di valori dinamici per azioni automatiche). Aggiungendo segnaposti simili a quelli utilizzati quando si specificano valori dinamici nelle azioni automatiche nel proprio CorpoOggetto, è possibile includere valori estratti dalle istanze degli oggetti in Service Desk per includerli nel payload. Se si utilizzano le variabili segnaposto, aggiungerle al contesto dell'oggetto RESTful.

Ogni oggetto che presenta il comportamento REST deve avere almeno un elemento nell'elenco di riferimento corrispondente che contiene il Corpo payload appropriato.

È possibile utilizzare uno strumento come Swagger per effettuare una chiamata al proprio endpoint al fine di supportare la progettazione di questo payload.

Per vedere un esempio pratico di utilizzo del servizio Web REST per automatizzare l'adempimento della richiesta utilizzando Ivanti Automation, consultare la Community Ivanti.