You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/data-factory/connector-rest.md
+29-29Lines changed: 29 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ ms.service: data-factory
7
7
ms.subservice: data-movement
8
8
ms.custom: synapse
9
9
ms.topic: conceptual
10
-
ms.date: 01/13/2022
10
+
ms.date: 02/14/2022
11
11
ms.author: makromer
12
12
---
13
13
@@ -508,7 +508,7 @@ This generic REST connector supports the following pagination patterns:
508
508
| Headers.*request_header* OR Headers['request_header']| "request_header" is user-defined, which references one header name in the next HTTP request. |
509
509
| EndCondition:*end_condition*| "end_condition" is user-defined, which indicates the condition that will end the pagination loop in the next HTTP request. |
510
510
| 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.
512
512
513
513
**Supported values** in pagination rules:
514
514
@@ -658,9 +658,9 @@ BaseUrl/api/now/table/t100
658
658
**Step 2**: Set **Pagination rules** as `"AbsoluteUrl.{id}" :"RANGE:1:100:1"`.
659
659
660
660
661
-
#### Example 3:Variables in Header
661
+
#### Example 3:Variables in Headers
662
662
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.
**Step 2**: Set **Pagination rules** as `"Headers.{id}" : "RARNGE:0:100:10"`.
676
676
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.":::
678
678
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.
680
680
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.
682
682
683
683
**Multiple requests:**
684
684
@@ -696,8 +696,8 @@ Response 1:
696
696
```
697
697
{
698
698
Data: [
699
-
{key1: val1, key2: val2},
700
-
{key1: val3, key2: val4}
699
+
{key1: val1, key2: val2},
700
+
{key1: val3, key2: val4}
701
701
]
702
702
}
703
703
```
@@ -706,15 +706,15 @@ Response 2:
706
706
```
707
707
{
708
708
Data: [
709
-
{key1: val5, key2: val6},
710
-
{key1: val7, key2: val8}
709
+
{key1: val5, key2: val6},
710
+
{key1: val7, key2: val8}
711
711
]
712
712
}
713
713
```
714
714
715
715
**Step 1**: Set the range of **Pagination rules** as Example 1 and leave the end of range empty as `"AbsoluteUrl.{offset}": "RANGE:0::1000"`
716
716
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:
718
718
719
719
- **Example 4.1: The pagination will end when the value of the specific node in response is empty**
720
720
@@ -727,7 +727,7 @@ Data: [
727
727
```
728
728
Set the end condition rule as `"EndCondition:$.data": "Empty"`.
729
729
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.":::
731
731
732
732
- **Example 4.2: The pagination will end when the value of the specific node in response dose not exist**
733
733
@@ -739,7 +739,7 @@ Data: [
739
739
```
740
740
Set the end condition rule as `"EndCondition:$.data": "NonExist"`
741
741
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.":::
743
743
744
744
- **Example 4.3: The pagination will end when the value of the specific node in response exists**
745
745
@@ -749,14 +749,14 @@ Data: [
749
749
{
750
750
Data: [
751
751
{key1: val991, key2: val992},
752
-
{key1: val993, key2: val994}
752
+
{key1: val993, key2: val994}
753
753
],
754
754
Complete: true
755
755
}
756
756
```
757
757
Set the end condition rule as `"EndCondition:$.Complete": "Exist"`
758
758
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.":::
760
760
761
761
- **Example 4.4: The pagination will end when the value of the specific node in response is a user-defined const value.**
762
762
@@ -766,7 +766,7 @@ Data: [
766
766
{
767
767
Data: [
768
768
{key1: val1, key2: val2},
769
-
{key1: val3, key2: val4}
769
+
{key1: val3, key2: val4}
770
770
],
771
771
Complete: false
772
772
}
@@ -777,15 +777,15 @@ Data: [
777
777
```
778
778
{
779
779
Data: [
780
-
{key1: val991, key2: val992},
781
-
{key1: val993, key2: val994}
780
+
{key1: val991, key2: val992},
781
+
{key1: val993, key2: val994}
782
782
],
783
783
Complete: true
784
784
}
785
785
```
786
786
Set the end condition rule as `"EndCondition:$.Complete": "Const:true"`
787
787
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.":::
789
789
790
790
- **Example 4.5: The pagination will end when the value of the header key in response is equal to user-defined const value**
791
791
@@ -795,7 +795,7 @@ Data: [
795
795
796
796
Set the end condition rule as `"EndCondition:headers.Complete": "Const:1"`
797
797
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.":::
799
799
800
800
- **Example 4.6: The pagination will end when the key exists in the response header**
801
801
@@ -805,7 +805,7 @@ Data: [
805
805
806
806
Set the end condition rule as `"EndCondition:headers.CompleteTime": "Exist"`
807
807
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.":::
809
809
810
810
#### Example 5:The range rule is not used but the end condition can be set to avoid endless requests
811
811
@@ -859,23 +859,23 @@ The last response is:
859
859
860
860
**Step 1**: Set **Pagination rules** as `"AbsoluteUrl": "$.paging.next"`
861
861
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.
863
863
864
-
#### Example 6:Set MaxRequestNumber to avoid endless request
864
+
#### Example 6:Set the max request number to avoid endless request
865
865
866
866
Set **MaxRequestNumber** to avoid endless request as shown in the following screenshot:
867
867
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.":::
869
869
870
-
#### Example 7:Support RFC 5988 pagination rule by default
870
+
#### Example 7:The RFC 5988 pagination rule is supported by default
871
871
872
872
The backend will automatically get the next URL based on the RFC 5988 style links in the header.
873
873
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.":::
875
875
876
876
> [!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.":::
879
879
880
880
## Use OAuth
881
881
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