Skip to content

Commit b0bdbae

Browse files
committed
Update content
1 parent 5719659 commit b0bdbae

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

articles/data-factory/connector-rest.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.service: data-factory
77
ms.subservice: data-movement
88
ms.custom: synapse
99
ms.topic: conceptual
10-
ms.date: 01/13/2022
10+
ms.date: 02/14/2022
1111
ms.author: makromer
1212
---
1313

@@ -508,7 +508,7 @@ This generic REST connector supports the following pagination patterns:
508508
| Headers.*request_header* OR Headers['request_header'] | "request_header" is user-defined, which references one header name in the next HTTP request. |
509509
| EndCondition:*end_condition* | "end_condition" is user-defined, which indicates the condition that will end the pagination loop in the next HTTP request. |
510510
| MaxRequestNumber | Indicates the maximum pagination request number. Leave it as empty means no limit. |
511-
| SupportRFC5988 | RFC 5988 is supported in the pagination rules. By default, this is set to true. It will only be honored if no other pagination rules are defined. If you don't want to enable this default pagination rule, you can set supportRFC5988 to false or just delete it in script.
511+
| SupportRFC5988 | RFC 5988 is supported in the pagination rules. By default, this is set to true. It will only be honored if no other pagination rules are defined. If you don't want to enable this default pagination rule, you can set `supportRFC5988` to `false` or just delete it in script.
512512

513513
**Supported values** in pagination rules:
514514

@@ -658,9 +658,9 @@ BaseUrl/api/now/table/t100
658658
**Step 2**: Set **Pagination rules** as `"AbsoluteUrl.{id}" :"RANGE:1:100:1"`.
659659
660660
661-
#### Example 3:Variables in Header
661+
#### Example 3:Variables in Headers
662662
663-
This example provides the configuration steps to send multiple requests whose variables are in Header.
663+
This example provides the configuration steps to send multiple requests whose variables are in Headers.
664664
665665
**Multiple requests:**<br/>
666666
RequestUrl: https://example/table<br/>
@@ -674,11 +674,11 @@ Request 100: Header(id->100)<br/>
674674
675675
**Step 2**: Set **Pagination rules** as `"Headers.{id}" : "RARNGE:0:100:10"`.
676676
677-
:::image type="content" source="media/connector-rest/pagination-example-3.png" alt-text="Screenshot showing the configuration steps to send multiple requests whose variables are in Header.":::
677+
:::image type="content" source="media/connector-rest/pagination-example-3.png" alt-text="Screenshot showing the configuration steps to send multiple requests whose variables are in Headers.":::
678678
679-
#### Example 4:Variables are in AbsoluteUrl/QueryParameters/Header, the end variable is not pre-defined and the end condition is based on the response.
679+
#### Example 4:Variables are in AbsoluteUrl/QueryParameters/Headers, the end variable is not pre-defined and the end condition is based on the response.
680680
681-
This example provides configuration steps to send multiple requests whose variables are in AbsoluteUrl/QueryParameters/Header but the end variable is not defined. For different responses, there are different settings end condition rule as shown in Example 4.1-4.6.
681+
This example provides configuration steps to send multiple requests whose variables are in AbsoluteUrl/QueryParameters/Headers but the end variable is not defined. For different responses, different end condition rule settings are shown in Example 4.1-4.6.
682682
683683
**Multiple requests:**
684684
@@ -696,8 +696,8 @@ Response 1:
696696
```
697697
{
698698
Data: [
699-
{key1: val1, key2: val2},
700-
{key1: val3, key2: val4}
699+
{key1: val1, key2: val2},
700+
{key1: val3, key2: val4}
701701
]
702702
}
703703
```
@@ -706,15 +706,15 @@ Response 2:
706706
```
707707
{
708708
Data: [
709-
{key1: val5, key2: val6},
710-
{key1: val7, key2: val8}
709+
{key1: val5, key2: val6},
710+
{key1: val7, key2: val8}
711711
]
712712
}
713713
```
714714
715715
**Step 1**: Set the range of **Pagination rules** as Example 1 and leave the end of range empty as `"AbsoluteUrl.{offset}": "RANGE:0::1000"`
716716
717-
**Step 2**: Set different end condition rules according to different last responses. There are six examples shown below:
717+
**Step 2**: Set different end condition rules according to different last responses. Six examples are shown below:
718718
719719
- **Example 4.1: The pagination will end when the value of the specific node in response is empty**
720720
@@ -727,7 +727,7 @@ Data: [
727727
```
728728
Set the end condition rule as `"EndCondition:$.data": "Empty"`.
729729
730-
:::image type="content" source="media/connector-rest/pagination-example-4-1.png" alt-text="Screenshot showing the EndCondition setting for example 4.1.":::
730+
:::image type="content" source="media/connector-rest/pagination-example-4-1.png" alt-text="Screenshot showing the EndCondition setting for Example 4.1.":::
731731
732732
- **Example 4.2: The pagination will end when the value of the specific node in response dose not exist**
733733
@@ -739,7 +739,7 @@ Data: [
739739
```
740740
Set the end condition rule as `"EndCondition:$.data": "NonExist"`
741741
742-
:::image type="content" source="media/connector-rest/pagination-example-4-2.png" alt-text="Screenshot showing the EndCondition setting for example 4.2.":::
742+
:::image type="content" source="media/connector-rest/pagination-example-4-2.png" alt-text="Screenshot showing the EndCondition setting for Example 4.2.":::
743743
744744
- **Example 4.3: The pagination will end when the value of the specific node in response exists**
745745
@@ -749,14 +749,14 @@ Data: [
749749
{
750750
Data: [
751751
{key1: val991, key2: val992},
752-
{key1: val993, key2: val994}
752+
{key1: val993, key2: val994}
753753
],
754754
Complete: true
755755
}
756756
```
757757
Set the end condition rule as `"EndCondition:$.Complete": "Exist"`
758758
759-
:::image type="content" source="media/connector-rest/pagination-example-4-3.png" alt-text="Screenshot showing the EndCondition setting for example 4.3.":::
759+
:::image type="content" source="media/connector-rest/pagination-example-4-3.png" alt-text="Screenshot showing the EndCondition setting for Example 4.3.":::
760760
761761
- **Example 4.4: The pagination will end when the value of the specific node in response is a user-defined const value.**
762762
@@ -766,7 +766,7 @@ Data: [
766766
{
767767
Data: [
768768
{key1: val1, key2: val2},
769-
{key1: val3, key2: val4}
769+
{key1: val3, key2: val4}
770770
],
771771
Complete: false
772772
}
@@ -777,15 +777,15 @@ Data: [
777777
```
778778
{
779779
Data: [
780-
{key1: val991, key2: val992},
781-
{key1: val993, key2: val994}
780+
{key1: val991, key2: val992},
781+
{key1: val993, key2: val994}
782782
],
783783
Complete: true
784784
}
785785
```
786786
Set the end condition rule as `"EndCondition:$.Complete": "Const:true"`
787787
788-
:::image type="content" source="media/connector-rest/pagination-example-4-4.png" alt-text="Screenshot showing the EndCondition setting for example 4.4.":::
788+
:::image type="content" source="media/connector-rest/pagination-example-4-4.png" alt-text="Screenshot showing the EndCondition setting for Example 4.4.":::
789789
790790
- **Example 4.5: The pagination will end when the value of the header key in response is equal to user-defined const value**
791791
@@ -795,7 +795,7 @@ Data: [
795795
796796
Set the end condition rule as `"EndCondition:headers.Complete": "Const:1"`
797797
798-
:::image type="content" source="media/connector-rest/pagination-example-4-5.png" alt-text="Screenshot showing the EndCondition setting for example 4.5.":::
798+
:::image type="content" source="media/connector-rest/pagination-example-4-5.png" alt-text="Screenshot showing the EndCondition setting for Example 4.5.":::
799799
800800
- **Example 4.6: The pagination will end when the key exists in the response header**
801801
@@ -805,7 +805,7 @@ Data: [
805805
806806
Set the end condition rule as `"EndCondition:headers.CompleteTime": "Exist"`
807807
808-
:::image type="content" source="media/connector-rest/pagination-example-4-6.png" alt-text="Screenshot showing the EndCondition setting for example 4.6.":::
808+
:::image type="content" source="media/connector-rest/pagination-example-4-6.png" alt-text="Screenshot showing the EndCondition setting for Example 4.6.":::
809809
810810
#### Example 5:The range rule is not used but the end condition can be set to avoid endless requests
811811
@@ -859,23 +859,23 @@ The last response is:
859859

860860
**Step 1**: Set **Pagination rules** as `"AbsoluteUrl": "$.paging.next"`
861861

862-
**Step 2**: If `next` in the last response is always same with the last request URL and not empty, endless requests will be sent. The end condition can be used to avoid endless requests. Therefore, set the **EndCondition** rule refer to Example 4.1-4.6.
862+
**Step 2**: If `next` in the last response is always same with the last request URL and not empty, endless requests will be sent. The end condition can be used to avoid endless requests. Therefore, set the end condition rule refer to Example 4.1-4.6.
863863

864-
#### Example 6:Set MaxRequestNumber to avoid endless request
864+
#### Example 6:Set the max request number to avoid endless request
865865

866866
Set **MaxRequestNumber** to avoid endless request as shown in the following screenshot:
867867

868-
:::image type="content" source="media/connector-rest/pagination-example-6.png" alt-text="Screenshot showing the MaxRequestNumber setting for example 6.":::
868+
:::image type="content" source="media/connector-rest/pagination-example-6.png" alt-text="Screenshot showing the MaxRequestNumber setting for Example 6.":::
869869

870-
#### Example 7:Support RFC 5988 pagination rule by default
870+
#### Example 7:The RFC 5988 pagination rule is supported by default
871871

872872
The backend will automatically get the next URL based on the RFC 5988 style links in the header.
873873

874-
:::image type="content" source="media/connector-rest/pagination-example-7-1.png" alt-text="Screenshot showing the MaxRequestNumber setting for example 6.":::
874+
:::image type="content" source="media/connector-rest/pagination-example-7-1.png" alt-text="Screenshot showing the MaxRequestNumber setting for Example 7.":::
875875

876876
> [!TIP]
877-
> If you don't want to enable this default pagination rule, you can set supportRFC5988 to false or just delete it in the script.
878-
> :::image type="content" source="media/connector-rest/pagination-example-7-2.png" alt-text="Screenshot showing how to disable RFC 5988 setting for example 7.":::
877+
> If you don't want to enable this default pagination rule, you can set `supportRFC5988` to `false` or just delete it in the script.
878+
> :::image type="content" source="media/connector-rest/pagination-example-7-2.png" alt-text="Screenshot showing how to disable RFC 5988 setting for Example 7.":::
879879
880880
## Use OAuth
881881
This section describes how to use a solution template to copy data from REST connector into Azure Data Lake Storage in JSON format using OAuth.

0 commit comments

Comments
 (0)