REST Patch [Not Recommended]

Overview

Note: We highly recommend that you use the HTTP Client Snap instead of REST Snaps to take advantage of the Capabilities of HTTP Client Snap. Learn more about Migrate from REST Snaps to HTTP Client Snap.

You can use the REST Patch Snap to execute an HTTP Patch method on a REST API service endpoint to replace business object resources. If the given resource does not exist, the Snap creates the resource.

Read-type Snap
Works in Ultra Tasks when the Batch size is set to 1.

We recommend that you set the batch size to 1.

Snap views


View	Description	Examples of upstream and downstream Snaps
Input	Each input document offers details associated with the file on which the patch action must be performed.	Script Mapper
Output	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..	JSON Splitter JSON Formatter
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 when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are: Stop Pipeline Execution Stops the current pipeline execution when an error occurs. 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.

Snap settings

Legend:

Expression icon (): Allows using JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
Upload : Uploads files. Learn more.

Learn more about the icons in the Snap settings dialog.


Field / Field set	Type	Description
Label	String	Specify a name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. Default value: REST Patch Example: REST Patch
Service URL	String/Expression	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: Note: The Service URL for a REST snap must be valid. If the Service URL contains any special characters, such as !, =, %21, $, and ^, the Snap throws an exception error. You can escape the special characters (using expression language) with one of the following methods: Use the global function `encodeURIComponent` on any variables that might contain special characters so that they are encoded properly. For example: `http://coresnapsqa-v4.s3.us-east-2.amazonaws.com/S3Account/'+encodeURIComponent(_fileName)` If you are aware of the code, use the code directly in the Service URL field. For example (where <%213%2912> is the code): `http://coresnapsqa-v4.s3.us-east-2.amazonaws.com/S3Account/Special_char_owner_%213%2912.json` We recommend that you use the encodeURIComponent method to escape the special characters. Default value: N/A Example: https://elastic.snaplogic.com/api/1/rest/public/runtime/snaplogic?start=1430377200000&end=1430420399000
HTTP Entity	String	Specify the JSON path to the HTTP entity data in the input map data. You can leave this field blank if there is no entity data to send to the service URL. 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	The number of documents to be included in a single request. The incoming documents will be accumulated in a list up to the defined batch size before it is submitted to the endpoint. Note: Make sure to set the batch size only if your REST endpoint expects a list. Default value: N/A Example: 20
Show all headers	Checkbox	The REST endpoint may return a response with multiple headers with the same header name. 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. Note: If any of these objects has a key-value format, it is parsed into the map data. Default value: Deselected
Form Upload	Use this field set to configure the fields required to upload multiple files and text. Learn more about Multipart Upload. By default, the Snap Settings display the fields required to upload a file. Click the Add icon to add new rows for adding file or text. This field set contains the following fields: Multipart Type Multipart Key Multipart Value HTTP Entity Filename to be used Multipart Content-Type
Multipart Type	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. Default value: N/A Example: REST Patch
Multipart Key	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
Multipart Value	String/Expression	Specify the file or text to be uploaded. If Multipart Type is FILE: 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 TEXT: The value should be expression enabled and enclosed in double quotes. Note: For Text part upload using the Form Upload, the HTTP Entity and Filename to be used fields are ignored. Default value: N/A Example: FILE: persons.csv \| TEXT: “sldb://file.txt”, “sampletext”
Filename to be used	String	Enter the name that you want to use for the file at the endpoint. Note: This property is expression-enabled. For more information on the expression language, see Understanding Expressions in SnapLogic and Using Expressions. For information on pipeline parameters, see Pipeline Properties. Default value: N/A Example: uploaded_file.csv
Multipart Content-Type	String	Select the content type headers for the data in the body of the multipart HTTP request. This enables the Snap to know 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 Note: If the Multipart Type is TEXT, it is generally not required to specify any value in this field. When you do not specify any value, the API uses the default value text/plain; charset=UTF-8. Note: To specify other HTTP headers, configure the headers in the HTTP Header field set. If you configure both Multipart Content-Type and HTTP Header fields, the value in the Multipart Content-Type gets precedence. Default value: N/A Example: text/csv
Trust all certificates	Checkbox	Select this checkbox to trust all certificates, such as self-signed certificates. Default value: Deselected
Follow redirects	Checkbox	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
Query parameters	Use this field set to add query parameters to your request. This field set comprises the following fields: Query parameter Query parameter value
Query parameter	String	Enter the name of the query parameter. Default value: N/A Example: id
Query parameter value	String	Enter the value that you want to assign to the parameter. Default value: N/A Example: $widget.id
HTTP Header	Use this field set to create the HTTP header key-value pairs required for defining the headers for different types of input (JSON, PDF, DOCX, and so on). If you want to specify only content-type headers, you can configure the Multipart Content-Type property instead. This field set comprises the following fields: Key Value Note: Configuring HTTP headers helps avoid problems in reading or opening files uploaded using the REST Post Snap. Refer to the Troubleshooting section, below, for more information.
Key	String	Enter the name of the HTTP header. Note: This property is expression-enabled. For more information on the expression language, see Understanding Expressions in SnapLogic and Using Expressions. For information on Pipeline Parameters, see Pipeline Properties. Default value: N/A Example: content-type
Value	String	Enter the value that you want to assign to the HTTP header. This property is expression-enabled. For more information on the expression language, see Understanding Expressions in SnapLogic and Using Expressions. For information on Pipeline Parameters, see Pipeline Properties. 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 Snap 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. Note: 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	String/Expression	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: This policy uses set-cookie and set-cookie2 for parsing. Note: When using a cookie policy, you must select Show All Headers checkbox to view the parsed cookies from the cookie policy specification. Default value: Ignore Cookies Example: RFC Strict
Read timeout	Integer	Specify the number of seconds for which the Snap waits before aborting the request due to a failure to read from the target service. Note: In some cases, the request does not return, such as during network issues. Configure a timeout to fail fast. Every Snap instance can have its own timeout settings. The Snap executes five retries with a short back-off time before failing. Default value: 900 Example: 60
Connection timeout	Integer	Specify the number of seconds for which the Snap waits before aborting the request due to a failure to establish a connection to the target endpoint or service. Default value: 30 Example: 60
Maximum request attempts	Integer	Specify the maximum number of attempts that the Snap must make to receive a response. If the attempts do not result in a response, the Snap terminates the request. 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	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. 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 single slash (/). 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. Note: In the 4.20 release, due to the HTTP client upgrade the URL paths were normalized by default. Hence, there was a change in behavior in handling the URL paths in 4.20 release when compared to 4.19. This change in behavior should not impact the existing pipelines, because most of the websites map URL paths with double or single slashes to the same endpoint. For example, https://snaplogic.com/company/diversity and https://snaplogic.com//company//diversity direct to the same endpoint. Therefore, we recommend you to select the Normalize URL checkbox. However, an exception to this is when you use non-standard URLs that differentiate the URL paths containing double slashes from those with single slashes and map them to different endpoints, in which case you must deselect Normalize URL checkbox. For example, http://host/pages/foo.html and http://host/pages//foo.html point to different URIs, and servers assign different meanings to them. Default value: Selected Example: Deselected
Snap execution	Dropdown list	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

Troubleshooting

Failed to execute HTTP request

Reason: Service URL must have a protocol, for example, http:// or https://. You get this error when your Service URL does not start with HTTP or HTTPS.

Resolution: Check the Snap properties. Specifically, verify whether your Service URL starts with HTTP or HTTPS.

status code = 404

Reason: Phrase = NOT FOUND, refer to the error_entity field in the error view document for more details. This typically means that your Service URL does not point to the correct endpoint.

Resolution: Check the values of Snap properties. Specifically, check your Service URL.

status code = 406

Reason: NOT ACCEPTABLE. This means that the endpoint is not receiving any details coming in from upstream Snaps.

Resolution: Ensure that you have valid references in the HTTP entity field.

status code = 400

Reason: BAD REQUEST. You see this error when the data in the HTTP entity field is not a reference.

Resolution: Ensure that you have valid references in the HTTP entity field.

HTTP entity: $<variable1> is undefined

Reason: '<variable1>' was not found while evaluating the sub-expression '$<variable1>'. This means that the referenced variable does not exist upstream.

Resolution: Check the spelling of the property or, if the property is optional, use the get() method. For example: $.get('<variable1>').

status code = 404

Reason: NOT FOUND, refer to the error_entity field in the error view document for more details. This means that SnapLogic could not find the data on which you want the PATCH call to execute.

Resolution: Check the values of Snap properties.

URL Parse Exception - 403

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

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

Reason: There are too many requests to the REST endpoint.

Resolution: 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.

Example

Remove SnapLogic Users from Groups