JamioPlug Service

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug Service >

JamioPlug Service

Descrizione

Per poter utilizzare il JamioPlug Service è necessario configurarlo tramite risorsa di tipo Configurazione ed eventualmente anche tramite risorsa di tipo Configurazione di Operazione.

 

La risorsa di tipo configurazione necessita della valorizzazione delle seguenti proprietà:

 

PlugName: Service;

Name: Nome da assegnare alla configurazione;

Description: descrizione opzionale della configurazione;

Nickname: Nickname da assegnare alla configurazione. Per quanto riguarda i caratteri speciali ammessi:

può contenere lettere maiuscole e minuscole dell'alfabeto inglese, numeri e i caratteri "-", "_", "."

non è case-sensitive

non può iniziare con uno dei caratteri "-", "_", "."

non può terminare con "." ;

AuthorizationScheme: se diverso da NoAuthorization, nell'uso del servizio sarà necessario fornire anche le Credenziali dello stesso tipo.

TrustAllCertificates: valore di default False.

 

Per ambienti on-premise è possibile gestire i certificati tramite le due proprietà:

 

ClientCerThumbprint;

ClientCerPath.

 

Inoltre, la risorsa di tipo Configurazione deve avere valorizzate la proprietà Fields come di seguito riportato:

 

Fields Configurazione JamioPlug Service

Nome

Descrizione

Tipo

Opzionale

BaseUrl

Testo che rappresenta la parte costante dell’URL del servizio da invocare (es.: “https://api.twitter.com/1.1/”).

String

 

Resource

Testo che rappresenta la parte variabile dell’URL del servizio da invocare, identifica in genere la risorsa specifica su cui il metodo agisce (es.: “statuses/show.json”).

String

Y

TokenPrefix

Testo che indica qual è il delimitatore iniziale dei Token. Il valore di default è ''. Vedi approfondimento.

String

Y

TokenSuffix

Testo che indica qual è il delimitatore finale dei Token. Il valore di default è ''. Vedi approfondimento.

String

Y

Headers

Lista chiave-valore contenente ulteriori informazioni da inviare nell'intestazione della chiamata, secondo standard HTTP.

E' possibile inserire qualsiasi chiave, per cui se si verifica una corrispondenza tra le chiavi e i parametri della configurazione (ad es. "ContentType"), i valori contenuti in questi ultimi vengono sovrascritti.

Dataset

Y

Host

Valore assegnato all’header host della richiesta HTTP. E' indipendente dall’indirizzo della richiesta e consiste di un hostname e di un numero di porta opzionale (es.: “www.contoso.com:8080″).

String

Y

UserAgent

Valore assegnato all’header user-agent della richiesta HTTP. Identifica l’applicazione client che invoca il servizio (ex.: “.NET Framework Test Client”).

Boolean

Y

Timeout

Periodo massimo di attesa di una risposta dal server. Passato tale tempo viene generato un errore di timeout. Espressa in secondi. Il valore di default è 100.

Int32

Y

MaximumAutomaticRedirections

Numero massimo di reindirizzamenti consentiti per la richiesta. Il valore -1 indica che non sono ammessi reindirizzamenti automatici. Il valore di default è 50.

Int32

Y

MaximumResponseHeadersLength

Lunghezza massima consentita per gli header della risposta. Espressa in kilobytes (1024 bytes). Se il parametro non è impostato si applica il valore di default pari a 64 Kb; un valore -1 indica che non sono imposti limiti alla lunghezza degli header ricevuti. Il valore di default è 64.

Int32

Y

 

 

La risorsa di tipo Configurazione di Operazione deve avere valorizzate la proprietà Fields come di seguito riportato:

 

Fields Configurazione di Operazione JamioPlug Service

Nome

Descrizione

Tipo

Opzionale

Parameters

Eventuali altre informazioni inviate sotto forma di lista di chiave-valore.

Per i parametri che compaiono sia in configurazione che nella RestRequest, prevalgono quelli specificati nella RestRequest.

Dataset

Y

Resource

Testo che rappresenta la parte variabile dell’URL del servizio da invocare, identifica in genere la risorsa specifica su cui il metodo agisce (es.: “statuses/show.json”).

Prevale rispetto a quella eventualmente specificata nella PlugConfiguration parent, ma non rispetto a quella eventualmente specificata nella RestRequest.

Reference

Y

BodyString

Testo che rappresenta il body della richiesta.

String

Y

ContentType

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

String

Y

EnableInvocationException

Abilita/disabilita la generazione di eccezioni http (cioè, nel caso l’invocazione REST restituisca uno Status Code diverso da 200 o 201, viene eventualmente generata una eccezione). Nel caso in cui la gestione delle eccezioni sia abilitata non sarà possibile leggere l’error code.

Il valore di default è False

Boolean

Y

DatasetConversionOptions

Definisce le opzioni di conversione da applicare ai dati riportati in DataSet.

DatasetConversionOptions

Y

CsvToListConversionOptions

Definisce le opzioni di conversione da applicare ai dati in formato CSV.

CsvToListConversionOptions

Y