RestRequest

<< Fare clic per visualizzazione il sommario >>

Percorso:  Gli oggetti del mondo Jamio > I tipi strutturati >

RestRequest

Consente di specificare i dati per l'invocazione di un servizio REST.

 

Il tipo è una struttura composta dalle seguenti proprietà:

 

Nome

Descrizione

Tipo

Resource

Risorsa da invocare. Nel caso in cui sia valorizzata nella configurazione la proprietà BaseUrl, la risorsa viene accodata al valore di BaseUrl.

String

Parameters

Eventuali parametri aggiuntivi da passare per la chiamata, se già specificati in configurazione vengono sovrascritti.

DataSet

Method

Metodo HTTP da invocare e può assumere i seguenti valori: GET, POST, PUT, PATCH, DELETE.

String

RequestFormat

Indica il formato della richiesta, può assumere i seguenti valori: String, JSON, XML, Stream, Multipart, Form. Il valore di default è String.

Il valore assegnato a questo parametro istruisce il Plug su quale oggetto in input alla richiesta utilizzare. Di seguito uno schema sulla corrispondenza tra i valori assunti dal parametro l'oggetto utilizzato dal Plug:

RestRequestFormat

Proprietà considerate nella costruzione della richiesta

String

BodyString

JSON

BodyDataset

XML

BodyDataset

Stream

BodyStream

Multipart

BodyMultipart

 

RestRequestFormat

ResponseFormat

Indica il formato che si desidera ottenere dalla invocazione al servizio.

Può assumere i seguenti valori: Default, String, JSON, XML, Stream, CSV.

Il valore di default è Default. In questo caso, viene sempre valorizzata la proprietà BodyString di RestResponse, inoltre:

se ContentType ricevuto nella risposta assume i valori “application/xml”, “text/xml”, “application/json”, “text/json” viene valorizzata anche la proprietà BodyDataset della risposta di tipo RestResponse;

se ContentType ricevuto nella risposta assume il valore “text/csv” viene valorizzata anche la proprietà BodyList della risposta di tipo RestResponse.

Negli altri casi:

RestResponseFormat

Proprietà di RestResponse  valorizzate

String

BodyString

JSON

BodyString BodyDataset

XML

BodyString

BodyDataset

Stream

BodyStream

CSV

BodyString

BodyList

RestResponseFormat

BodyString

Testo che indica il body della richiesta.

String

BodyDataset

Dato strutturato contente i dati di input da inviare nella richiesta.

Tali dati vengono convertiti in stringa a seconda di come le proprietà RequestFormat e DatasetConversionOptions sono valorizzate.

DataSetValue

BodyStream

Riferimento al file da inviare.

Può essere un riferimento da un Attachment, ad un FileComponent, ad una risorsa che contiene un unico attachment o ad una risorsa di tipo Document che ha un unico componente di tipo file o un componente principale di tipo file.

Reference

BodyMultipart

Lista di MultipartElement, per la costruzione di un body multipart.

ArrayValue

ContentType

Definisce il tipo di oggetto codificato nella richiesta (es.: “application/x-www-form-urlencoded”, “text/plain”) secondo le specifiche MIME Type.

Se non valorizzato, esso viene impostato a:

application/json se il parametro RequestFormat assume il valore JSON;

application/xml se il parametro RequestFormat assume il valore XML;

application/x-www-form-urlencoded se il parametro RequestFormat assume il valore Form.

String

Headers

Lista chiave-valore contenente informazioni aggiuntive per l'intestazione della chiamata, secondo lo standard HTTP.

Se già specificate in configurazione vengono sovrascritte.

DataSetValue

TokenPrefix

Indica qual’è il delimitatore iniziale dei Token. E' consigliabile non usare ## perché sono i caratteri utilizzati per i placeholder gestiti dalle credenziali.

Prevale su quello eventualmente specificato nella configurazione.

String

TokenSuffix

Indica qual’è il delimitatore finale dei Token. E' consigliabile non usare ## perché sono i caratteri utilizzati per i placeholder gestiti dalle credenziali.

Prevale su quello eventualmente specificato nella configurazione.

String

TokensData

Ulteriori dati utilizzabili per sostituire in PlugConfiguration, PlugOperationConfiguration, RestRequest, MultipartElement eventuali stringhe presenti nell'Url (ottenuta dall'accodamento del valore nel parametro Resource al valore di BaseUrl), in BodyString, in BodyDataset, in Parameters, in Headers (sia chiavi che valori) o in StringContent.

DataSetValue

DatasetConversionOptions

Opzioni di conversione di JSON o XML in dataset e viceversa.

DatasetConversionOptions

CsvToListConversionOptions

Opzioni di conversione di CSV in lista

CsvToListConversionOptions