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
+26-22Lines changed: 26 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -663,12 +663,12 @@ BaseUrl/api/now/table/t100
663
663
This example provides the configuration steps to send multiple requests whose variables are in Headers.
664
664
665
665
**Multiple requests:**<br/>
666
-
RequestUrl: https://example/table<br/>
667
-
Request 1: Header(id->0)<br/>
668
-
Request 2: Header(id->10)<br/>
669
-
Request 2: Header(id->20)<br/>
666
+
RequestUrl: *https://example/table*<br/>
667
+
Request 1: `Header(id->0)`<br/>
668
+
Request 2: `Header(id->10)`<br/>
669
+
Request 2: `Header(id->20)`<br/>
670
670
......<br/>
671
-
Request 100: Header(id->100)<br/>
671
+
Request 100: `Header(id->100)`<br/>
672
672
673
673
*Step 1*: Input `{id}` in **Additional headers**.
674
674
@@ -718,32 +718,32 @@ Data: [
718
718
719
719
- **Example 4.1: The pagination will end when the value of the specific node in response is empty**
720
720
721
-
Last response:
721
+
The REST API returns the last response in the following structure:
722
722
723
723
```
724
724
{
725
725
Data: []
726
726
}
727
727
```
728
-
Set the end condition rule as **"EndCondition:$.data": "Empty"**.
728
+
Set the end condition rule as **"EndCondition:$.data": "Empty"** to end the pagination when the value of the specific node in response is empty.
729
729
730
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
734
-
Last response:
734
+
The REST API returns the last response in the following structure:
735
735
736
736
```
737
737
{
738
738
}
739
739
```
740
-
Set the end condition rule as **"EndCondition:$.data": "NonExist"**.
740
+
Set the end condition rule as **"EndCondition:$.data": "NonExist"** to end the pagination when the value of the specific node in response dose not exist.
741
741
742
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
746
-
Last response:
746
+
The REST API returns the last response in the following structure:
747
747
748
748
```
749
749
{
@@ -754,14 +754,13 @@ Data: [
754
754
Complete: true
755
755
}
756
756
```
757
-
Set the end condition rule as **"EndCondition:$.Complete": "Exist"**.
757
+
Set the end condition rule as **"EndCondition:$.Complete": "Exist"** to end the pagination when the value of the specific node in response exists.
758
758
759
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
763
-
Last response:
764
-
763
+
The REST API returns the response in the following structure:
765
764
```
766
765
{
767
766
Data: [
@@ -771,8 +770,9 @@ Data: [
771
770
Complete: false
772
771
}
773
772
```
774
-
775
-
or
773
+
......
774
+
775
+
And the last response is in the following structure:
776
776
777
777
```
778
778
{
@@ -783,27 +783,31 @@ Data: [
783
783
Complete: true
784
784
}
785
785
```
786
-
Set the end condition rule as **"EndCondition:$.Complete": "Const:true"**.
786
+
Set the end condition rule as **"EndCondition:$.Complete": "Const:true"** to end the pagination when the value of the specific node in response is a user-defined const value.
787
787
788
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
792
-
Response header 1: header(Complete->0)<br/>
792
+
The header keys in REST API responses are shown in the structure below:
793
+
794
+
Response header 1: `header(Complete->0)`<br/>
793
795
......<br/>
794
-
Last Response header: header(Complete->1)<br/>
796
+
Last Response header: `header(Complete->1)`<br/>
795
797
796
-
Set the end condition rule as **"EndCondition:headers.Complete": "Const:1"**.
798
+
Set the end condition rule as **"EndCondition:headers.Complete": "Const:1"** to end the pagination when the value of the header key in response is equal to user-defined const value.
797
799
798
800
:::image type="content" source="media/connector-rest/pagination-example-4-5.png" alt-text="Screenshot showing the EndCondition setting for Example 4.5.":::
799
801
800
802
- **Example 4.6: The pagination will end when the key exists in the response header**
801
803
802
-
Response header 1: header()<br/>
804
+
The header keys in REST API responses are shown in the structure below:
805
+
806
+
Response header 1: `header()`<br/>
803
807
......<br/>
804
-
Last Response header: header(CompleteTime->20220920)<br/>
808
+
Last Response header: `header(CompleteTime->20220920)`<br/>
805
809
806
-
Set the end condition rule as **"EndCondition:headers.CompleteTime": "Exist"**.
810
+
Set the end condition rule as **"EndCondition:headers.CompleteTime": "Exist"** to end the pagination when the key exists in the response header.
807
811
808
812
:::image type="content" source="media/connector-rest/pagination-example-4-6.png" alt-text="Screenshot showing the EndCondition setting for Example 4.6.":::
0 commit comments