Versions Compared

Version Old Version 44 New Version 45
Changes made by

Sandhya Sriram

Kalpana Malladi

Saved on

Key

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

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

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

Image RemovedImage Added

Prerequisites

None.

Supported Features

Works in Ultra Task Pipelines. We recommend you to 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

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
pageREST Get

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 macro
nameResponse_Entity_Type
pageREST Get

Default Value: DEFAULT
Example: TEXT

Cookie Policy

Dropdown list


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

Info

When using a cookie policy, you must select Show All Headers checkbox to view the parsed cookies from the cookie policy specification.



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 macro
nameRetry_Request_Interval
pageREST Post

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.

Examples

Creating and Deleting an Account in Salesforce Using REST Snaps

In this example Pipeline, we demonstrate how we create an account in Salesforce and delete it using REST Snaps.


Prerequisites: To use this example, you need at least an account in the free version of Salesforce. To create a Salesforce account, see Salesforce Developers.

Initially, we configure the JSON Generator Snap—we enter a name Test Account—the account that you want to create.


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

  1. We use the URL provided by Salesforce for managing the accounts available in your instance.
  2. We use '$' in the HTTP entity field to indicate that we want to use the string coming from the Snap upstream.
  3. We add an HTTP header to the Snap, instructing Salesforce to read the document coming in as a JSON file.


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


When we validate the Snap, it creates an account in the Salesforce instance and displays the following output:



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

We now want to delete the account that you just created. To do so, we need to isolate the account ID from the REST Post Snap's output. We use a Mapper for this task.


Upon validation, the Mapper Snap displays the following output:


We now use the REST Delete Snap to delete the newly-created account.


When the Snap is executed, the account is deleted.

Downloads

Multiexcerpt include macro
namedownload_instructions
pageOpenAPI

Attachments
patterns*.slp, *.zip

Insert excerpt
REST Snap Pack
REST Snap Pack
nopaneltrue

See Also