Versions Compared

Version Old Version 56 New Version Current
Changes made by

Cindy Hall (Unlicensed)

Gouri Bhagchandani

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

Multiexcerpt include macro
nameKI_use_HTTP_client_instead
templateData[]
pageREST Snap Pack
addpanelfalse

You can use the REST Delete Snap to delete business object resources using a REST API call.

Prerequisites

None.

Supported Features

Works in Ultra Task PipelinesTasks. We recommend that you set the batch size to 1.

Limitations and Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input Document
  • Min: 0
  • Max: 1
  • REST Get
  • Mapper
  • Script
Each input document contains the ID of the object to be deleted at the REST API service endpoint.
OutputDocument
  • Min: 0
  • Max: 1
  • REST Post
  • JSON Formatter
  • Mapper

Each output document contains response data from the REST API service endpoint detailing the status of the request.

Snap Settings

REST Get

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

  • As a JavaScript expression in the 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:


Field NameField TypeDescription
Label*String

Insert excerpt
File Writer
File Writer
nopaneltrue

Default Value: REST Delete
Example: REST Delete

Service URL*

String/Expression
Multiexcerpt include macro
nameREST_Serviceurl
page
Note

The Service URL for the REST snap has to 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) using one of the following methods:

We recommend you to use the former (encodeURIComponent) method to escape the special characters.

Default Value: N/A
Example: https://www.example.com/slm/webservice/v2.0/defect/%s".replace("%s", $.widget.id)

HTTP entityString/Expression

Multiexcerpt include macro
nameHTTP_entity
pageREST Post

Default Value: N/A
Example: $response.entity.id 

Batch sizeString

Multiexcerpt include macro
nameBatch_Size
pageREST Patch

Default Value: N/A
Example: 50

Show all headersCheckbox


Multiexcerpt macro
nameShow_All_Headers

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.

If any of these objects has a key-value format, it is parsed into the map data.


Default Value: Deselected
Example: N/A

Trust all certificates*Checkbox

Multiexcerpt include macro
nameTrust_All_Certificates
pageREST Post

Default Value: Deselected
Example: N/A

Follow redirects*Checkbox

Multiexcerpt include macro
nameFollow_Redirects
pageREST Post

Default Value: Selected
Example: N/A

Query parameters

Multiexcerpt include macro
nameQuery_Parameters_REST
pageREST Post

Query parameter

String

Specify the name (or key) of the query parameter.

Default Value: N/A
Example: oauth2_access_token

Query parameter value

String/Expression

Specify the value associated with the query parameter.

Default Value: N/A
Example: $account.access_token

HTTP header

Multiexcerpt include macro
nameHTTP_Header
pageREST Post

Key

String

Specify the name that you want to use for the HTTP header.

Default Value: N/A
Example: User-Agent

Value

String/Expression

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

Default Value: N/A
Example: SnapLogic

Response entity typeString Multiexcerpt include macronameResponse_Entity_TypepageREST Get

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.

Info

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

Cookie Policy

Dropdown list


Multiexcerpt macro
nameCookie Policy

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.

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 timeoutInteger

Multiexcerpt include macro
nameRead_Timeout
pageREST Post

Default Value: 900
Example: 1500

Connection timeoutInteger

Multiexcerpt include macro
nameConnection_Timeout
pageREST Post

Default Value: 30
Example: 45

Maximum request attemptsInteger

Multiexcerpt include macro
nameMaximum_Request_Attempts
pageREST Post

Default Value: 5
Example: 3

Retry request intervalInteger

Multiexcerpt include macronameRetry_Request_IntervalpageREST PostSpecify the time in seconds to wait before retrying the request.

Default Value: 3
Example: 10

Normalize URLCheckbox
Insert excerpt
REST Get
REST Get
nopaneltrue
Snap ExecutionString

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

Example: Validate and Execute

Troubleshooting

ErrorReasonResolution
Batch execution failedThe Pipeline ended before the batch could complete execution due to a connection error.

Verify that the Batch size field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.

The provided URI is invalidIllegal character in scheme nameVerify the URI and parameters that you provide are syntactically correct.
URL Parse Exception - 403The 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.

Example

Creating and Deleting an Account in SnapLogic Using REST Snaps

Prerequisites:

  • A valid account.

This example Pipeline demonstrates how to create an account in SnapLogic and delete it using REST Snaps.
          

Initially, we configure the JSON Generator Snap where we mention the project name - testDeleteProject111.

          


Then, we configure the REST Post Snap to create the project in SnapLogic using the account-name string of your choice. To do so:

  1. We use the SnapLogic URL for creating the project in your instance.
  2. We use '$projectName' in the HTTP entity field to indicate that we want to use the string coming from the upstream Snap.


 We click the Account tab and select the account that we want to use with Snap. 

          

When we validate the Snap, it creates a project in the SnapLogic instance. The Snap displays the following output:

         

The id field lists out the unique identifier of the new project created by Snap.

We now want to delete the project that you just created. To do so, we use a REST Delete for this task.

         
The project you created is deleted from the SnapLogic instance. Upon validation, the REST Delete Snap displays the following output:

          

Download this Pipeline.

Downloads

Multiexcerpt include macro
namedownload_instructions
pageOpenAPI

Attachments
patterns*.slp, *.zip

Insert excerpt
REST Snap Pack
REST Snap Pack
nopaneltrue

SnapLogic Product Glossary