Configurare REST in un'attività di copia

Questo articolo illustra come usare l'attività di copia nella pipeline di dati per copiare dati da e in un endpoint REST.

In particolare, questo connettore REST generico supporta:

  • Copiare dati da un endpoint REST usando i metodi GET o POST e copiando i dati in un endpoint REST usando i metodi POST, PUT o PATCH .
  • La paginazione nelle API REST.
  • Per REST come origine, copiare la risposta JSON REST così come è o analizzarla usando il mapping dello schema. È supportato solo il payload della risposta in JSON .

Configurazione supportata

Per la configurazione di ogni scheda in un'attività di copia, passare rispettivamente alle sezioni seguenti.

Generali

Per configurazione della scheda Generale , passare a Generale.

Origine

Le proprietà seguenti sono supportate per REST nella scheda Origine di un'attività di copia.

Screenshot showing source tab and the list of properties.

Sono necessarie le prime tre proprietà seguenti:

  • Tipo di archivio dati: selezionare Esterno.
  • Connessione ion: selezionare una connessione REST dall'elenco delle connessioni. Se non esiste alcuna connessione, creare una nuova connessione REST selezionando Nuovo.
  • tipo di Connessione ion: selezionare REST.
  • URL relativo: URL relativo alla risorsa che contiene i dati. Quando questa proprietà non viene specificata, viene usato solo l'URL specificato nella definizione di connessione. Il connettore HTTP copia i dati dall'URL combinato: [URL specified in connection]/[relative URL specified].

In Avanzate è possibile specificare i campi seguenti:

  • Metodo di richiesta: metodo HTTP. I valori consentiti sono GET (impostazione predefinita) e POST.

    Screenshot showing request method.

  • Timeout della richiesta: timeout (valore intervallo di tempo) per la richiesta HTTP per ottenere una risposta. Si tratta del timeout per ottenere una risposta, non per leggere i dati della risposta. Il valore predefinito è 00:01:40.

  • Intervallo di richiesta (ms): intervallo tra richieste diverse per più pagine in millisecondi. Il valore dell'intervallo di richiesta deve essere un numero compreso tra [10, 60000].

  • Intestazioni aggiuntive: intestazioni di richiesta HTTP aggiuntive.

    Screenshot showing additional headers.

  • Regole di paginazione: regole di paginazione per comporre le richieste di pagina successiva. Per informazioni dettagliate, vedere la sezione relativa al supporto della paginazione .

    Screenshot showing pagination rules.

  • Colonne aggiuntive: aggiungere altre colonne di dati per archiviare il percorso relativo o il valore statico dei file di origine. Se si usa un valore statico, è possibile usare espressioni personalizzate per generarla.

    Screenshot showing additional columns.

Destinazione

Le proprietà seguenti sono supportate per REST nella scheda Destinazione di un'attività di copia.

Screenshot showing destination tab.

Sono necessarie le prime tre proprietà seguenti:

  • Tipo di archivio dati: selezionare Esterno.
  • Connessione ion: selezionare una connessione REST dall'elenco delle connessioni. Se non esiste alcuna connessione, creare una nuova connessione REST selezionando Nuovo.
  • tipo di Connessione ion: selezionare REST.
  • URL relativo: URL relativo alla risorsa che contiene i dati. Quando questa proprietà non viene specificata, viene usato solo l'URL specificato nella definizione di connessione. Il connettore HTTP copia i dati dall'URL combinato: [URL specified in connection]/[relative URL specified].

In Avanzate è possibile specificare i campi seguenti:

  • Metodo di richiesta: metodo HTTP. I valori consentiti sono POST (impostazione predefinita), PUT e PATCH.

  • Timeout della richiesta: timeout (valore intervallo di tempo) per la richiesta HTTP per ottenere una risposta. Questo valore è il timeout per ottenere una risposta, non il timeout per scrivere i dati. Il valore predefinito è 00:01:40.

  • Intervallo di richiesta (ms): intervallo tra richieste diverse per più pagine in millisecondi. Il valore dell'intervallo di richiesta deve essere un numero compreso tra [10, 60000].

  • Dimensioni batch di scrittura: numero di record da scrivere nella destinazione REST per batch. Il valore predefinito è 10000.

  • Tipo di compressione HTTP: tipo di compressione HTTP da usare durante l'invio di dati con livello di compressione ottimale. I valori consentiti sono None e GZip.

  • Intestazioni aggiuntive: intestazioni di richiesta HTTP aggiuntive.

    Screenshot showing additional headers.

Mapping

Per la configurazione della scheda Mapping , passare a Configurare i mapping nella scheda Mapping. Il mapping non è supportato quando sia l'origine che la destinazione sono dati gerarchici.

Impostazione

Per la configurazione della scheda Impostazioni, passare a Configurare le altre impostazioni nella scheda Impostazioni.

Riepilogo tabella

Le tabelle seguenti contengono altre informazioni sull'attività di copia in REST.

Informazioni sull'origine

Nome Descrizione Valore Richiesto Proprietà script JSON
Tipo di archivio dati Tipo di archivio dati. Area di lavoro
Esterno
Set di dati di esempio
type
Connessione Connessione all'archivio dati di origine. <connessione> connection
Tipo di connessione Tipo di connessione. Selezionare REST. REST type:
RestResource
URL relativo URL relativo della risorsa che contiene i dati. Quando questa proprietà non viene specificata, viene usato solo l'URL specificato nella definizione di connessione. Il connettore HTTP copia i dati dall'URL combinato: [URL specified in connection]/[relative URL specified]. <URL relativo> No relativeUrl
Metodo request Metodo HTTP. I valori consentiti sono GET (impostazione predefinita) e POST. GET
POST
No requestMethod
Timeout della richiesta Timeout (valore intervallo di tempo) per la richiesta HTTP per ottenere una risposta. Si tratta del timeout per ottenere una risposta, non per leggere i dati della risposta. Il valore predefinito è 00:01:40. timespan No httpRequestTimeout
Intervallo richiesta (ms) Intervallo di tempo tra richieste diverse per più pagine in millisecondi. Il valore dell'intervallo di richiesta deve essere un numero compreso tra [10, 60000]. [10, 60000] No requestInterval
Intestazioni aggiuntive Intestazioni richiesta HTTP aggiuntive. <intestazioni aggiuntive> No additionalHeaders
Regole di paginazione Regole di paginazione per comporre le richieste di pagina successive. Per informazioni dettagliate, vedere la sezione relativa al supporto della paginazione . Vai alla paginazione No paginationRules
Colonne aggiuntive Aggiungere altre colonne di dati al percorso relativo o al valore statico dei file di origine dell'archivio. L'espressione è supportata per quest'ultima. • Name
•Valore
No additionalColumns:
•Nome
•Valore

Informazioni sulla destinazione

Nome Descrizione Valore Richiesto Proprietà script JSON
Tipo di archivio dati Tipo di archivio dati. Area di lavoro
Esterno
type
Connessione Connessione all'archivio dati di origine. <connessione> connection
Tipo di connessione Tipo di connessione. Selezionare REST. REST type:
RestResource
URL relativo URL relativo della risorsa che contiene i dati. Quando questa proprietà non viene specificata, viene usato solo l'URL specificato nella definizione di connessione. Il connettore HTTP copia i dati dall'URL combinato: [URL specified in connection]/[relative URL specified]. <URL relativo> No relativeUrl
Metodo request Metodo HTTP. I valori consentiti sono POST (impostazione predefinita), PUT e PATCH. POST
GET
PATCH
No requestMethod
Timeout della richiesta Timeout (valore intervallo di tempo) per la richiesta HTTP per ottenere una risposta. Si tratta del timeout per ottenere una risposta, non per leggere i dati della risposta. Il valore predefinito è 00:01:40. timespan No httpRequestTimeout
Intervallo richiesta (ms) Intervallo di tempo tra richieste diverse per più pagine in millisecondi. Il valore dell'intervallo di richiesta deve essere un numero compreso tra [10, 60000]. [10, 60000] No requestInterval
Dimensioni batch di scrittura Numero di record da scrivere nella destinazione REST per batch. Il valore predefinito è 10000. <numero di righe>
(intero)
No writeBatchSize
Tipo di compressione HTTP Tipo di compressione HTTP da usare durante l'invio di dati con livello di compressione ottimale. I valori consentiti sono None e GZip. Nessuno
GZip
No httpCompressionType
Intestazioni aggiuntive Intestazioni richiesta HTTP aggiuntive. <intestazioni aggiuntive> No additionalHeaders