Page Comparison

Specify the service endpoint URL of REST API. You can provide the URL in one of the following ways:

• As a JavaScript expression in expression language.

For example: http://coresnapsqa-v4.s3.us-east-2.amazonaws.com/S3Account/'+encodeURIComponent("Special_char_owner_!3)12.json")

• As a plain string that you should enclose in double quotes ("").

For example: "https://www.example.com/slm/webservice/v2.0/defect/%s".replace("%s", $.widg et.id)

For Snaps using AWS Signature V4 accounts, you can use the canonical name (CNAME) for the URI so it's not necessary for the URL to end with amazonaws.com or have the region and service provided in it. However, if you are using the CNAME you must provide it in the AWS Region and Service Name fields in the AWS Signature V4 account.

The host name in the CNAME must be equal to the bucket name.

For example:
Previous URI: https://jsmith-bucket.nia3.snaplogic.net.s3.us-west-1.amazonaws.com/HttpClientTest/test1

New URI with CNAME: https://jsmith-sltest.nia3.snaplogic.net/HttpClientTest/test1

Here, the bucket name is jsmith-bucket.nia3.snaplogic.net

The Snap finds the value at the JSON path $.widget.id in the input data and replaces "%s" in the Service URL with the value. You can connect File Reader and JSON Parser Snaps upstream of a REST Put Snap and prepare the following JSON file for the File Reader Snap:

[
 { "widget": { "id": "111", "name": "foo" } }
 { "widget": { "id": "555", "name": "bar" } }
]
"https://www.example.com/data/v27.0/sobjects/Account"

The value that you want to assign to the parameter.

The name of the HTTP header.

The value that you want to assign to the HTTP header.

Select one of the following response entity types you want the Snap to display in the output document.:

• DEFAULT - Select this option to enable the Snap to process the response automatically. The response entity is processed automatically based on the Content-Type header in the response. If the content provided does not parse with the provided Content-Type, the snap will result in an error.
  The following two scenarios describe the Snap’s behavior when using the Process Array checkbox::

  • When you select the Process Array checkbox, the Snap parses JSON or XML and produces a stream of documents at the output view.

  • When you deselect the Process Array checkbox, the Snaps sends the data as it is at the output view.   

• TEXT - Select this option to enable, the Snap to produce an entity of string type.

• BINARY - Select this option to enable the Snap to produce an entity of byte array type.

Enter the expression that must be evaluated on the output document to true or false, to indicate whether there are more records available. The Snap continues to read the next page until this expression evaluates to false in the new set of output documents.

To see this property in action, see Retrieving Contact Information from HubSpot or Retrieving Contact Information from HubSpot Using Upstream Values, below.

Enter the expression that is evaluated on the output document to a URL that the Snap must use to get the next page. This property is used for the REST Get pagination feature.

The Next URL has two components, which are structured as follows:
"<endpoint_URL>&<offset_indicator>=" + $entity['last_ID_retrieved']

• The first component contains the URL of the endpoint and an instruction to look for the offset indicator. ("<endpoint_URL>&<offset_indicator>=").

• The second component is a pointer to the parameter in the API response that contains the ID of the last entity retrieved. This tells the endpoint that the next page must contain entities that are returned after the entity number listed in the Next URL.

You can create the Next URL in either of the following ways:

• You can enter the entire URL in the expression and include the parameter required to fetch the next set of documents.
  Example: "https://api.hubapi.com/contacts/v1/lists/all/contacts/all?hapikey=demo&vidOffset=" + $entity['vid-offset']

• If you have the URL part of the Next URL as an input from an upstream Snap, you can structure the Next URL expression using the original parameter in the API response received. 
  For example, if you have the following input coming from upstream:

  Paste code macro
  [ { "url": "https://api.hubapi.com/contacts/v1/lists/all/contacts/all?hapikey=demo&vidOffset" } ]

  You can configure the Next URL field as follows:

  Paste code macro
  $original.msg+ "=" + $entity['vid-offset']

  Here, vid-offset is the API response parameter containing the ID of the last output received from the endpoint.
  If the API response does not contain a field with information about the last entity retrieved, you can use the Snap's output document count to fetch the next page.
  For example, <https://domain.com/object/page/' + (snap.out.totalCount + 1).toString()>

For additional information, see Retrieving Contact Information from HubSpot or Retrieving Contact Information from HubSpot Using Upstream Values.