• Script
• Mapper

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.

• REST Post
• JSON Formatter

Default value: REST Get

Required. 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.

  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 ("").

  "https://www.example.com/slm/webservice/v2.0/defect/%s".replace("%s", $.widget.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"

Default value: N/A

Default value: Deselected

Select this checkbox to trust all certificates, such as self-signed certificates.

Default value: Deselected

Select this checkbox to enable the Snap to follow redirects.

• If you select this checkbox, the Snap receives a redirect response, such as a 301 or 302 response code, it sends another request to the URL specified in the response Location header.
• If you deselect this checkbox, the Snap does not make another request, and the 301/302 response appears in the output view.

Default value: Selected

• 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.

Default value: DEFAULT

• 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.

Default value: Ignore Cookies

• In some cases, the request does not return, such as during network issues. For those a timeout can be configured to allow failing fast.
• Every Snap instance can have its own timeout settings.
• The Snap will execute five retries within a couple of seconds back-off time before it fails.

Default value: 900

Default value: 30

Default value: 5

Default value: 3

• 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.

Default value: Connection errors

For example, https://example.com/path//to//file is converted to https://example.com/path/to/file.

Deselecting this checkbox reverts the Snap to 4.19 Snaplex behavior, wherein the URL paths were not normalized by default.

Default value: Selected

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

Default value: N/A

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:

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

$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()

Default value: N/A

Default value: 0

• If this property is deselected, only one response header will be shown in the output document.
• If selected, the response header displays all the response header values received as a list of objects.

Default value: Deselected

• 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.

Default value: Validate & Execute