Skip to content

Commit b6ec7b0

Browse files
committed
Update screenshots and text
1 parent 0a4cd06 commit b6ec7b0

22 files changed

+25
-20
lines changed

articles/data-factory/connector-rest.md

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -547,11 +547,11 @@ baseUrl/api/now/table/incident?sysparm_limit=1000&sysparm_offset=10000
547547

548548
*Step 1*: Input `sysparm_offset={offset}` either in **Base URL** or **Relative URL** as shown in the following screenshots:
549549

550-
:::image type="content" source="media/connector-rest/pagination-example-1-rest-linked-service-base-url.png" alt-text="Screenshot showing the configuration step 1 to send multiple requests whose variables are in QueryParameters.":::
550+
:::image type="content" source="media/connector-rest/pagination-rule-example-1-rest-linked-service-base-url.png" alt-text="Screenshot showing one configuration to send multiple requests whose variables are in QueryParameters.":::
551551

552552
or
553553

554-
:::image type="content" source="media/connector-rest/pagination-example-1-rest-linked-service-relative-url.png" alt-text="Screenshot showing the configuration step 2 to send multiple requests whose variables are in QueryParameters.":::
554+
:::image type="content" source="media/connector-rest/pagination-rule-example-1-rest-linked-service-relative-url.png" alt-text="Screenshot showing another configuration to send multiple requests whose variables are in QueryParameters.":::
555555

556556
*Step 2*: Set **Pagination rules** as either option 1 or option 2:
557557

@@ -574,8 +574,13 @@ BaseUrl/api/now/table/t100
574574

575575
*Step 1*: Input `{id}` either in **Base URL** in the linked service configuration page or **Relative URL** in the dataset connection pane.
576576

577-
*Step 2*: Set **Pagination rules** as **"AbsoluteUrl.{id}" :"RANGE:1:100:1"**.
577+
:::image type="content" source="media/connector-rest/pagination-rule-example-2-rest-linked-service-base-url.png" alt-text="Screenshot showing one configuration to send multiple requests whose variables are in AbsoluteUrl.":::
578+
579+
or
578580

581+
:::image type="content" source="media/connector-rest/pagination-rule-example-2-rest-linked-service-relative-url.png" alt-text="Screenshot showing another configuration to send multiple requests whose variables are in AbsoluteUrl.":::
582+
583+
*Step 2*: Set **Pagination rules** as **"AbsoluteUrl.{id}" :"RANGE:1:100:1"**.
579584

580585
#### Example 3:Variables in Headers
581586

@@ -592,7 +597,7 @@ Request 100: `Header(id->100)`<br/>
592597

593598
*Step 2*: Set **Pagination rules** as **"Headers.{id}" : "RARNGE:0:100:10"**.
594599

595-
:::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.":::
600+
:::image type="content" source="media/connector-rest/pagination-rule-example-3.png" alt-text="Screenshot showing the pagination rule to send multiple requests whose variables are in Headers.":::
596601

597602
#### Example 4:Variables are in AbsoluteUrl/QueryParameters/Headers, the end variable is not pre-defined and the end condition is based on the response
598603

@@ -650,7 +655,7 @@ Response 2:
650655
```
651656
Set the end condition rule as **"EndCondition:$.data": "Empty"** to end the pagination when the value of the specific node in response is empty.
652657

653-
:::image type="content" source="media/connector-rest/pagination-example-4-1.png" alt-text="Screenshot showing the EndCondition setting for Example 4.1.":::
658+
:::image type="content" source="media/connector-rest/pagination-rule-example-4-1.png" alt-text="Screenshot showing the EndCondition setting for Example 4.1.":::
654659

655660
- **Example 4.2: The pagination ends when the value of the specific node in response dose not exist**
656661

@@ -662,7 +667,7 @@ Response 2:
662667
```
663668
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.
664669

665-
:::image type="content" source="media/connector-rest/pagination-example-4-2.png" alt-text="Screenshot showing the EndCondition setting for Example 4.2.":::
670+
:::image type="content" source="media/connector-rest/pagination-rule-example-4-2.png" alt-text="Screenshot showing the EndCondition setting for Example 4.2.":::
666671

667672
- **Example 4.3: The pagination ends when the value of the specific node in response exists**
668673

@@ -681,7 +686,7 @@ Response 2:
681686
```
682687
Set the end condition rule as **"EndCondition:$.Complete": "Exist"** to end the pagination when the value of the specific node in response exists.
683688

684-
:::image type="content" source="media/connector-rest/pagination-example-4-3.png" alt-text="Screenshot showing the EndCondition setting for Example 4.3.":::
689+
:::image type="content" source="media/connector-rest/pagination-rule-example-4-3.png" alt-text="Screenshot showing the EndCondition setting for Example 4.3.":::
685690

686691
- **Example 4.4: The pagination ends when the value of the specific node in response is a user-defined const value**
687692

@@ -714,7 +719,7 @@ Response 2:
714719
```
715720
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.
716721

717-
:::image type="content" source="media/connector-rest/pagination-example-4-4.png" alt-text="Screenshot showing the EndCondition setting for Example 4.4.":::
722+
:::image type="content" source="media/connector-rest/pagination-rule-example-4-4.png" alt-text="Screenshot showing the EndCondition setting for Example 4.4.":::
718723

719724
- **Example 4.5: The pagination ends when the value of the header key in response equals to user-defined const value**
720725

@@ -726,7 +731,7 @@ Response 2:
726731

727732
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.
728733

729-
:::image type="content" source="media/connector-rest/pagination-example-4-5.png" alt-text="Screenshot showing the EndCondition setting for Example 4.5.":::
734+
:::image type="content" source="media/connector-rest/pagination-rule-example-4-5.png" alt-text="Screenshot showing the EndCondition setting for Example 4.5.":::
730735

731736
- **Example 4.6: The pagination ends when the key exists in the response header**
732737

@@ -738,7 +743,7 @@ Response 2:
738743

739744
Set the end condition rule as **"EndCondition:headers.CompleteTime": "Exist"** to end the pagination when the key exists in the response header.
740745

741-
:::image type="content" source="media/connector-rest/pagination-example-4-6.png" alt-text="Screenshot showing the EndCondition setting for Example 4.6.":::
746+
:::image type="content" source="media/connector-rest/pagination-rule-example-4-6.png" alt-text="Screenshot showing the EndCondition setting for Example 4.6.":::
742747

743748
#### Example 5:Set end condition to avoid endless requests when range rule is not defined
744749

@@ -798,58 +803,58 @@ The last response is:
798803

799804
Set **MaxRequestNumber** to avoid endless request as shown in the following screenshot:
800805

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

803808
#### Example 7:The RFC 5988 pagination rule is supported by default
804809

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

807-
:::image type="content" source="media/connector-rest/pagination-example-7-1.png" alt-text="Screenshot showing the MaxRequestNumber setting for Example 7.":::
812+
:::image type="content" source="media/connector-rest/pagination-rule-example-7-http-header.png" alt-text="Screenshot showing the sample http header for Example 7.":::
808813

809814
> [!TIP]
810815
> If you don't want to enable this default pagination rule, you can set `supportRFC5988` to `false` or just delete it in the script.
811816
>
812-
> :::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.":::
817+
> :::image type="content" source="media/connector-rest/pagination-rule-example-7-disable-rfc5988.png" alt-text="Screenshot showing how to disable RFC 5988 setting for Example 7.":::
813818
814819
#### Example 8: The next request URL is from the response body when use pagination in mapping data flows
815820

816821
This example states how to set the pagination rule and the end condition rule in mapping data flows when the next request URL is from the response body.
817822

818823
The response schema is shown below:
819824

820-
:::image type="content" source="media/connector-rest/pagination-example-8-response-schema.png" alt-text="Screenshot showing the response schema of Example 8.":::
825+
:::image type="content" source="media/connector-rest/pagination-rule-example-8-response-schema.png" alt-text="Screenshot showing the response schema of Example 8.":::
821826

822827
The pagination rules should be set as the following screenshot:
823828

824-
:::image type="content" source="media/connector-rest/pagination-example-8-pagination-rule.png" alt-text="Screenshot showing how to set the pagination rule for Example 8.":::
829+
:::image type="content" source="media/connector-rest/pagination-rule-example-8.png" alt-text="Screenshot showing how to set the pagination rule for Example 8.":::
825830

826831
By default, the pagination will stop when body **.{@odata.nextLink}** is null or empty.
827832

828833
But if the value of **@odata.nextLink** in the last response body is equal to the last request URL, then it will lead to the endless loop. To avoid this condition, define end condition rules.
829834

830835
- If **Value** in the last response is **Empty**, then the end condition rule can be set as below:
831836

832-
:::image type="content" source="media/connector-rest/pagination-example-8-end-condition-1.png" alt-text="Screenshot showing setting the end condition rule when the last response is empty.":::
837+
:::image type="content" source="media/connector-rest/pagination-rule-example-8-end-condition-1.png" alt-text="Screenshot showing setting the end condition rule when the last response is empty.":::
833838

834839
- If the value of the complete key in the response header equals to true indicates the end of pagination, then the end condition rule can be set as below:
835840

836-
:::image type="content" source="media/connector-rest/pagination-example-8-end-condition-2.png" alt-text="Screenshot showing setting the end condition rule when the complete key in the response header equals to true indicates the end of pagination.":::
841+
:::image type="content" source="media/connector-rest/pagination-rule-example-8-end-condition-2.png" alt-text="Screenshot showing setting the end condition rule when the complete key in the response header equals to true indicates the end of pagination.":::
837842

838843
#### Example 9: The response format is XML and the next request URL is from the response body when use pagination in mapping data flows
839844

840845
This example states how to set the pagination rule in mapping data flows when the response format is XML and the next request URL is from the response body. As shown in the following screenshot, the first URL is *https://\<user\>.dfs.core.windows.net/bugfix/test/movie_1.xml*
841846

842847

843-
:::image type="content" source="media/connector-rest/pagination-example-9-situation.png" alt-text="Screenshot showing the response format is XML and the next request URL is from the response body.":::
848+
:::image type="content" source="media/connector-rest/pagination-rule-example-9-situation.png" alt-text="Screenshot showing the response format is XML and the next request URL is from the response body.":::
844849

845850

846851
The response schema is shown below:
847852

848-
:::image type="content" source="media/connector-rest/pagination-example-9-response-schema.png" alt-text="Screenshot showing the response schema of Example 9.":::
853+
:::image type="content" source="media/connector-rest/pagination-rule-example-9-response-schema.png" alt-text="Screenshot showing the response schema of Example 9.":::
849854

850855
The pagination rule sytax is the same as in Example 8 and should be set as below in this example:
851856

852-
:::image type="content" source="media/connector-rest/pagination-example-9-pagination-rule.png" alt-text="Screenshot showing setting the pagination rule for Example 9.":::
857+
:::image type="content" source="media/connector-rest/pagination-rule-example-9.png" alt-text="Screenshot showing setting the pagination rule for Example 9.":::
853858

854859

855860
## Use OAuth

0 commit comments

Comments
 (0)