REST configureren in een kopieeractiviteit
In dit artikel wordt beschreven hoe u de kopieeractiviteit in de gegevenspijplijn gebruikt om gegevens van en naar een REST-eindpunt te kopiëren.
Deze algemene REST-connector ondersteunt met name:
- Gegevens kopiëren van een REST-eindpunt met behulp van de GET- of POST-methoden en het kopiëren van gegevens naar een REST-eindpunt met behulp van de POST-, PUT- of PATCH-methoden.
- Paginering in de REST API's.
- Voor REST als bron kopieert u het REST JSON-antwoord als zodanig of parseert u het met behulp van schematoewijzing. Alleen de nettolading van het antwoord in JSON wordt ondersteund.
Ondersteunde configuratie
Voor de configuratie van elk tabblad onder een kopieeractiviteit gaat u respectievelijk naar de volgende secties.
Algemeen
Voor de configuratie van het tabblad Algemeen gaat u naar Algemeen.
Bron
De volgende eigenschappen worden ondersteund voor REST op het tabblad Bron van een kopieeractiviteit.
De volgende eerste drie eigenschappen zijn vereist:
- Gegevensarchieftype: Selecteer Extern.
- Verbinding maken ion: Selecteer een REST-verbinding in de lijst met verbindingen. Als er geen verbinding bestaat, maakt u een nieuwe REST-verbinding door Nieuw te selecteren.
- Verbinding maken iontype: Selecteer REST.
- Relatieve URL: een relatieve URL naar de resource die de gegevens bevat. Wanneer deze eigenschap niet is opgegeven, wordt alleen de URL gebruikt die is opgegeven in de verbindingsdefinitie. De HTTP-connector kopieert gegevens van de gecombineerde URL:
[URL specified in connection]/[relative URL specified].
Onder Geavanceerd kunt u de volgende velden opgeven:
Aanvraagmethode: de HTTP-methode. Toegestane waarden zijn GET (standaard) en POST.
Time-out van aanvraag: de time-out (de tijdspannewaarde) voor de HTTP-aanvraag om een antwoord te krijgen. Deze waarde is de time-out voor het ophalen van een antwoord, niet de time-out voor het lezen van antwoordgegevens. De standaardwaarde is 00:01:40.
Aanvraaginterval (ms): de intervaltijd tussen verschillende aanvragen voor meerdere pagina's in milliseconden. De waarde van het aanvraaginterval moet een getal zijn tussen [10, 60000].
Aanvullende headers: Aanvullende HTTP-aanvraagheaders.
Pagineringsregels: de pagineringsregels voor het opstellen van volgende paginaaanvragen. Raadpleeg de sectie voor pagineringsondersteuning voor meer informatie.
Aanvullende kolommen: voeg meer gegevenskolommen toe om het relatieve pad of de statische waarde van bronbestanden op te slaan. Als u een statische waarde gebruikt, kunt u aangepaste expressies gebruiken om deze te genereren.
Doel
De volgende eigenschappen worden ondersteund voor REST op het tabblad Bestemming van een kopieeractiviteit.
De volgende eerste drie eigenschappen zijn vereist:
- Gegevensarchieftype: Selecteer Extern.
- Verbinding maken ion: Selecteer een REST-verbinding in de lijst met verbindingen. Als er geen verbinding bestaat, maakt u een nieuwe REST-verbinding door Nieuw te selecteren.
- Verbinding maken iontype: Selecteer REST.
- Relatieve URL: een relatieve URL naar de resource die de gegevens bevat. Wanneer deze eigenschap niet is opgegeven, wordt alleen de URL gebruikt die is opgegeven in de verbindingsdefinitie. De HTTP-connector kopieert gegevens van de gecombineerde URL:
[URL specified in connection]/[relative URL specified].
Onder Geavanceerd kunt u de volgende velden opgeven:
Aanvraagmethode: de HTTP-methode. Toegestane waarden zijn POST (standaard), PUT en PATCH.
Time-out van aanvraag: de time-out (de tijdspannewaarde) voor de HTTP-aanvraag om een antwoord te krijgen. Deze waarde is de time-out voor het ophalen van een antwoord, niet de time-out voor het schrijven van de gegevens. De standaardwaarde is 00:01:40.
Aanvraaginterval (ms): de intervaltijd tussen verschillende aanvragen voor meerdere pagina's in milliseconden. De waarde van het aanvraaginterval moet een getal zijn tussen [10, 60000].
Grootte van schrijfbatch: het aantal records dat moet worden geschreven naar de REST-bestemming per batch. De standaardwaarde is 10000.
Http-compressietype: HTTP-compressietype dat moet worden gebruikt tijdens het verzenden van gegevens met optimaal compressieniveau. Toegestane waarden zijn Geen en GZip.
Aanvullende headers: Aanvullende HTTP-aanvraagheaders.
Toewijzing
Ga voor de configuratie van het tabblad Toewijzing naar Uw toewijzingen configureren onder het tabblad Toewijzing. Toewijzing wordt niet ondersteund wanneer zowel de bron als de bestemming hiërarchische gegevens zijn.
Instellingen
Ga voor de configuratie van het tabblad Instellingen naar De andere instellingen configureren op het tabblad Instellingen.
Tabelsamenvatting
De volgende tabellen bevatten meer informatie over de kopieeractiviteit in REST.
Brongegevens
| Name | Beschrijving | Waarde | Vereist | JSON-scripteigenschap |
|---|---|---|---|---|
| Gegevensarchieftype | Het gegevensarchieftype. | • Werkruimte • Extern • Voorbeeldgegevensset |
Ja | type |
| Verbinding | Uw verbinding met het brongegevensarchief. | <uw verbinding> | Ja | verbinding |
| Verbindingstype | Uw verbindingstype. Selecteer REST. | REST | Ja | type: RestResource |
| Relatieve URL | Een relatieve URL naar de resource die de gegevens bevat. Wanneer deze eigenschap niet is opgegeven, wordt alleen de URL gebruikt die is opgegeven in de verbindingsdefinitie. De HTTP-connector kopieert gegevens van de gecombineerde URL: [URL specified in connection]/[relative URL specified]. |
<uw relatieve URL> | Nee | relativeUrl |
| Aanvraagmethode | De HTTP-methode. Toegestane waarden zijn GET (standaard) en POST. | • GET • POST |
Nee | requestMethod |
| Time-out aanvragen | De time-out (de tijdsperiodewaarde) voor de HTTP-aanvraag om een antwoord te krijgen. Deze waarde is de time-out voor het ophalen van een antwoord, niet de time-out voor het lezen van antwoordgegevens. De standaardwaarde is 00:01:40. | tijdsbestek | Nee | httpRequestTimeout |
| Aanvraaginterval (ms) | De intervaltijd tussen verschillende aanvragen voor meerdere pagina's in milliseconden. De waarde van het aanvraaginterval moet een getal zijn tussen [10, 60000]. | [10, 60000] | Nee | requestInterval |
| Extra headers | Aanvullende HTTP-aanvraagheaders. | <uw extra headers> | Nee | additionalHeaders |
| Pagineringsregels | De pagineringsregels voor het opstellen van aanvragen van de volgende pagina. Raadpleeg de sectie voor pagineringsondersteuning voor meer informatie. | Ga naar paginering | Nee | pagineringRules |
| Aanvullende kolommen | Voeg meer gegevenskolommen toe aan het relatieve pad of statische waarde van de bronbestanden van het archief. Expressie wordt ondersteund voor de laatste. | • Naam •Waarde |
Nee | additionalColumns: •Naam •Waarde |
Doelgegevens
| Name | Beschrijving | Waarde | Vereist | JSON-scripteigenschap |
|---|---|---|---|---|
| Gegevensarchieftype | Het gegevensarchieftype. | • Werkruimte • Extern |
Ja | type |
| Verbinding | Uw verbinding met het brongegevensarchief. | <uw verbinding> | Ja | verbinding |
| Verbindingstype | Uw verbindingstype. Selecteer REST. | REST | Ja | type: RestResource |
| Relatieve URL | Een relatieve URL naar de resource die de gegevens bevat. Wanneer deze eigenschap niet is opgegeven, wordt alleen de URL gebruikt die is opgegeven in de verbindingsdefinitie. De HTTP-connector kopieert gegevens van de gecombineerde URL: [URL specified in connection]/[relative URL specified]. |
<uw relatieve URL> | Nee | relativeUrl |
| Aanvraagmethode | De HTTP-methode. Toegestane waarden zijn POST (standaard), PUT en PATCH. | • POST • GET • PATCH |
Nee | requestMethod |
| Time-out aanvragen | De time-out (de tijdsperiodewaarde) voor de HTTP-aanvraag om een antwoord te krijgen. Deze waarde is de time-out voor het ophalen van een antwoord, niet de time-out voor het lezen van antwoordgegevens. De standaardwaarde is 00:01:40. | tijdsbestek | Nee | httpRequestTimeout |
| Aanvraaginterval (ms) | De intervaltijd tussen verschillende aanvragen voor meerdere pagina's in milliseconden. De waarde van het aanvraaginterval moet een getal zijn tussen [10, 60000]. | [10, 60000] | Nee | requestInterval |
| Grootte van schrijfbatch | Aantal records dat per batch naar de REST-bestemming moet worden geschreven. De standaardwaarde is 10000. | <aantal rijen> (geheel getal) |
Nee | writeBatchSize |
| Http-compressietype | Http-compressietype dat moet worden gebruikt tijdens het verzenden van gegevens met optimaal compressieniveau. Toegestane waarden zijn Geen en GZip. | • Geen • GZip |
Nee | httpCompressionType |
| Extra headers | Aanvullende HTTP-aanvraagheaders. | <uw extra headers> | Nee | additionalHeaders |