Input 

Document

• Min: 0

• Max: 1

• Mapper

• Script

• Router

Each input document offers details associated with the file on which the patch action must be performed.

Output

Document

• Min: 0

• Max: 1

• JSON Splitter

• JSON Formatter

• Join

Each output document contains details associated with the status of the patch operation.

If the Snap fails during the operation, it sends an error document containing the error, reason, resolution, and stacktrace to the Error view. For this to happen, however, the error view must be enabled.

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*

String

Default Value: REST Patch
Example: REST Patch

Service URL*

URL

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 hostname 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:

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

HTTP Entity

String

Default Value: $  (the HTTP entity data is at the root of the input map data)
Example: $.entity  (if the HTTP entity data is the value of the "entity" key at the root of the input map data)

Batch size

Integer

Default Value: N/A
Example: 20

Show all headers

Checkbox

Default Value: Deselected

Form Upload

Default Value: N/A
Example: REST Patch

Dropdown list

Choose the type of multipart upload that you want to initiate. The available options are:

• FILE: Use this option to upload a file.

• TEXT: Use this option to upload text.

String

Specify the key required for the multi-part to upload a file or text as required.

HTTP POST uses multi-part entity to achieve the form upload. The form data of its multi-part entity contains key-value pairs. Multipart Key can be anything and it depends on the service endpoint.

Default Value: file
Example: file, initial_comment, channels

String/Expression

Specify the the file or text to be uploaded.

If Multipart Type is FILE, the following are applicable:

• The file protocols supported for file values are 'sldb:///' and 'file:///'.

• If the file path is a relative path, it is considered as an SLDB file.

• If this field is not empty, HTTP Entity and Batch size fields are ignored and the Multipart Key field is required.

• If the value is an expression, the input document is used to evaluate the expression. Each input document invokes one file upload.

• This field does not support wildcard or glob patterns.

If Multipart Type is a TEXT, then

• The value should be expression enabled and enclosed in double quotes.

Default Value: N/A
Example: 

• FILE: persons.csv

• TEXT: “sldb://file.txt”, “sampletext”

String

Enter the name that you want to use for the file at the endpoint.

Default Value: N/A
Example: uploaded_file.csv

String

Select the content type headers for the data in the body of the multipart HTTP request. This enables the Snap how to read or interpret the input file .

The available options are:

• application/octet-stream

• text/plain

• application/json

• text/csv

• text/html

• image/jpeg
  
  

Default Value: N/A








Example: text/csv

Trust all certificates

Checkbox

Default Value: Deselected

Follow redirects

Checkbox

Default Value: Selected

Query parameters

String

Enter the name of the query parameter.

Default Value: N/A
Example: id

String

Enter the value that you want to assign to the parameter.

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

HTTP Header

String

Enter the name of the HTTP header.

Default Value: N/A
Example: content-type

String

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

Default Value: N/A
Example: application/json

Response entity type

String

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

• DEFAULT - This option enables 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.

If you select TEXT or BINARY, the Snap does not parse the entity content. If you select DEFAULT, the Snap produces the expected result in most cases, but if it fails to process as expected, you can set the Response entity type to TEXT or BINARY.

Default Value: DEFAULT
Example: N/A

Cookie Policy

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.

Default Value: Ignore Cookies








Example: RFC Strict

Read timeout

Integer

Default Value: 900
Example: 1200

Connection timeout

Integer

Default Value: 30
Example: 60

Maximum request attempts 

Integer

Default Value: 5
Example: 3

Retry request interval

Integer

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

Default Value: 3
Example: 10

Retry Policy

String

Default Value: Connection errors
Example: All errors

Normalize URL

Checkbox

Select this checkbox to normalize the Service URL. This enables the Snap to convert double slashes (//) in the URL path to a single slash (/).
For example,
https://example.com/path//to//file is converted to https://example.com/path/to/file.

Default Value: Selected

Snap Execution

Checkbox

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.

Default Value: Validate & Execute
Example: Validate & Execute

Failed to execute HTTP request

Service URL must have a protocol, e.g. http://, https://

You get this error when your service URL does not start with HTTP or HTTPS.

Check the Snap properties. Specifically, check whether your service URL starts with HTTP or HTTPS.