Pagination

Pagination

Task Factory ›› Data Flow Components ›› Sources ›› Rest ››
Parent Previous Next


Pagination Settings


Pagination Mode


Retreieve from response and set url querystring



  Cursor Value Token Path - When returning large result sets, web services may employ a method called 'Cursoring' to break up the data into smaller chunks. The value token path is the Json token / XML path that exists within the results.

     Example: {

                      "pagingToken":"12345",

                      "results":{"name":"Pragmatic Works"}

                      }

     The token path in this instance is pagingToken.

  Is Cursor Token Value A Url - Select this option if the cursor token value is a URL.

  Cursor Query String Parameter - The query string parameter will be appended to each round trip (after the first) to the Api Endpoint url. (Example: Creating the parameter pagingToken will append it to the end of the Url such as the following: http://webservice/endpoint?pagingToken=12345.)

  Cursor Finished Value - This token or value defined by the user tells the component all of the results have been retrieved. This can be left blank if the endpoint omits the results token when it's finished.

  Pause Between Round Trips (Seconds) - The number of seconds between calls to the application.


Retrieve from response and set replacement value



  Page Token Path - The value used in the Pagination Token

  Pagination Template - Sets the template that can be replaced in the Endpoint Url or Post Body. (Example: http://myapp.com/token?value= {%paging%})

  Pagination Token Finished Value - Identifies the final value

  Pause Between Round Trips (Seconds) - The number of seconds between calls to the application.


Manage in component and set replacement value



  Page Start Variable -

  Increment By -

  Max Number Of Pages -

  Pagination Template -

  Last Page Detection - Identifies the method the endpoint

o   End paging when status code is  

o   End paging when response contains error message

o   End paging when resultset doesn't contain any rows

  Pause Between Round Trips (Seconds) - The number of seconds between calls to the application.