Input 

Document

• Min: 0

• Max: 1

• Mapper

• Script

• Router

Each input document offers details associated with the data required from the target RESTful server.

Output

Document

• Min: 0

• Max: 1

• JSON Splitter

• JSON Formatter

• Join

Each output document contains data retrieved from the RESTful web server.

If the Snap fails during the operation, it sends an error document to the error view containing the fields error, reason, resolution, and stacktrace. However, you must enable the Error view to view the error document.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

• Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Label*

Default Value: REST Get
Example: Get User Details

String

Specify a unique name for the Snap.

Service URL*

Default Value: N/A
Example: https://elastic.snaplogic.com/api/1/rest/
public/runtime/snaplogic?
start=1430377200000&end=1430420399000

String/Expression

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:

Process array

Default Value: Deselected

Checkbox

Select to produce a stream of documents with one record in each document. 

• If the Process Array property is selected, it takes a response that’s an array [{"value": 1}, {"value": 2}] and provides the individual inner json as separate documents. If the content provided doesn’t parse with the provided Content-Type, the snap will error.

• If the Process Array property is not selected, the Snaps attempts to convert the entity to a string or a byte array depending on the response headers. 

Trust all certificates

Default Value: Deselected

Checkbox

Follow redirects

Default Value: Selected

Checkbox

Query parameters

Default Value: N/A
Example: $User

Query parameter

Default Value: N/A
Example: id

String

The name of the query parameter.

Query parameter value

Default Value: N/A
Example: $widget.id

String/Expression

The value that you want to assign to the parameter.

HTTP Header

Key

Default Value: N/A
Example: content-type

String/Expression

The name of the HTTP header.

Value

Default Value: N/A
Example: application/json

String/Expression

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

Response entity type

Default Value: DEFAULT
Example: TEXT

Dropdown list

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.

Cookie Policy

Default Value: Ignore Cookies
Example: RFC Strict

Dropdown list

Select a Cookie Policy from the following options:

• Browser Compatibility: This policy is compatible with different servers even if they are not completely standards-compliant. If you are facing issues while parsing cookies, you should try using this policy.

• Ignore Cookies: This cookie policy ignores all cookies. You should use this policy to prevent HTTP Client from accepting and sending cookies.

• RFC Strict: This policy uses the set-cookie header

• RFC Lax: The policy uses set-cookie and set-cookie2 for parsing.

Read timeout

Default Value: 900
Example: 60

Integer

Connection timeout

Default Value: 30
Example: 60

Integer

Maximum request attempts 

Default Value: 5
Example: 3

Integer

Retry request interval

Default Value: 3
Example: 10

Integer

Specify the time in seconds to wait before retrying the request.

Retry Policy

Default Value: Connection errors
Example: All errors

String

Select how you want to handle connection and error responses from the following options:

• Connection errors: Occurs when a client fails to establish a secure connection to the server.

• Connection and auth errors (401/403): Occurs when either the user authorization fails or access to the page/resource is forbidden.

• Connection and client errors (4xx): Occurs when the request for the resource contains bad syntax or when the resource is not found (404).

• Connection and server errors (5xx): Occurs when the server is unable to complete a request.

• All errors: Applies to all of the above-listed errors.

Normalize URL

Checkbox

Has next

Default Value: N/A
Example: $entity['has-more']

String/Expression

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.

Next URL

Default Value: N/A
Example: $entity['has-more']

String/Expression

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:

  You can configure the Next URL field as follows:

  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.

Pagination interval(s)

Default Value: 0
Example: 10

Integer

The number of seconds for the Snap to wait before attempting to get the next page.

Show all headers

Default Value: Deselected

Checkbox

Snap Execution

Default Value: Validate & Execute
Example: Validate & Execute

String

Select one of the following three modes in which the Snap executes:

• Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

• Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

• Disabled: Disables the Snap and all Snaps that are downstream from it.

 Accept-Encoding

 gzip    

 Accept

 */*

Failed to execute HTTP request.

The Service URL must have a protocol, such as http://, https://.

Check the Snap properties. Specifically, check your entry in the Service URL field.

<Service_URL>: Name or service not known. This basically means that the service URL you entered is not accessible.

Failure: Validation errors: property_map.settings.serviceUrl.value: Could not compile expression: <Service_URL>

The snap settings are not correct. Encountered extraneous input ':' at line 1:5; expecting={<EOF>, '||', '&&', '^', '==', '!=', '>', '<', '>=', '<=', '+', '-', '*', '/', '%', '?', 'instanceof', 'in', 'matches', '[', '(', '.', PropertyRef}.

This means that you have turned expressions on (

Fix the snap configuration and try executing again. Please check expression syntax. Ensure that your service URL is a proper expression; or turn off the expression control (

URL Parse Exception - 403

The Service URL path might be containing any of the following special characters:
!, =, %, #, $, ^&()_¢äâêîôûñç¡¿ÉÙËǨ°¸ðø©¢¾A+²½µ®§÷¶þ 

To escape the special characters, use the global function encodeURIComponent on any variables that might contain special characters so that they are encoded properly.

Too many Requests - 429

There are too many requests to REST endpoint.

Wait for the retry to succeed.

Rest related Snaps extract the response header and automatically retry when they encounter status 429.

By default, the retry interval (Retry-After) is specified in the HTTP response header. If no value is available for Retry-After, then the Snap’s Retry Interval value is used.