In this article

Table of Contents

maxLevel	2
absoluteUrl	true

Overview

Use 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 Pipelines. We recommend you to set the batch size to 1.

Limitations and Known Issues

None.

Snap Input and Output

Input/Output	Type of View	Number of Views	Examples of Upstream and Downstream Snaps	Description
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.
Output	Document	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

Parameter Name

Data Type

Field Dependency	Description

Default ValueExample


Label*

String

N/A

Insert excerpt

	File Writer
	File Writer
nopanel	true

N/ADelete Identified Objects

Default Value: REST Delete
Example: REST Delete

Service URL

String

N/A

Multiexcerpt include macro

name	REST_Serviceurl
page	REST 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:

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, http://coresnapsqa-v4.s3.us-east-2.amazonaws.com/S3Account/Special_char_owner_%213%2912.json; where <%213%2912> is the code.

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

N

Default Value: N/A

"

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

HTTP entity

String

N/A

Multiexcerpt include macro

name	HTTP_entity
page	REST Post

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

(if the HTTP entity that you want to delete is the value of the response.entity.id key in the input map.)

Batch size

Integer

N/A

Multiexcerpt include macro

name	Batch_Size
page	REST Patch

NN

Default Value: N/A
Example: 50

Show all headers

Checkbox

Multiexcerpt macro

name	Show_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.

Deselected

Default Value: Deselected
Example: N/A

Trust all certificates

Check box

N/A

Multiexcerpt include macro

name	Trust_All_Certificates
page	REST Post

Default Value: Deselected

N

Example: N/A

Follow redirects

Check box

N/A

Multiexcerpt include macro

name	Follow_Redirects
page	REST Post

Default Value: Selected

N

Example: N/A

Query parameters

Fieldset

Multiexcerpt include macro

name	Query_Parameters_REST
page	REST Post

Default Value: N/A
Example:

Query parameter

String

N/A	Specify the name (or key) of the query parameter.

N

Default Value: N/A
Example: oauth2_access_token

Query parameter value

String

N/A	Specify the value associated with the query parameter.

N

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

HTTP header

Fieldset

Multiexcerpt include macro

name	HTTP_Header
page	REST Post

Multiexcerpt include macro

name	HTTP_Header
page	REST Post

Key

String

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

N

Default Value: N/A
Example: User-Agent

Value

String

N/A	Specify the value that you want to assign to the HTTP header.

N

Default Value: N/A
Example: SnapLogic

Response entity type

String

N/A

Multiexcerpt include macro

name	Response_Entity_Type
page	REST Get

Default Value: DEFAULT
Example: TEXT

Read timeout

Integer

N/A

Multiexcerpt include macro

name	Read_Timeout
page	REST Post

Default Value: 900
Example: 1500

Connection timeout

Integer

N/A

Multiexcerpt include macro

name	Connection_Timeout
page	REST Post

Default Value: 30
Example: 45

Maximum request attempts

Integer

N/A

Multiexcerpt include macro

name	Maximum_Request_Attempts
page	REST Post

Default Value: 5
Example: 3

Retry request interval

Integer

N/A

Multiexcerpt include macro

name	Retry_Request_Interval
page	REST Post

Default Value: 3
Example: 10

Snap Execution

String

N/A

Multiexcerpt include macro

name	Execution_Detail_Write
page	SOAP Execute

Default Value: Validate and Execute
Example: Execute only

Troubleshooting

Error	Reason	Resolution
Batch execution failed	The 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 invalid	Illegal character in scheme name	Please verify Verify the provided URI and parameters that you provide are syntactically correct.
URL Parse Exception - 403	The 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.

Examples

Creating and Deleting an Account in Salesforce Using REST Snaps

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

note

Image Added

To

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.

You design the Pipeline as follows:

Image Removed
In the JSON Generator Snap, you

Initially, we configure the JSON Generator Snap—we enter a name

for the

Test Account—the account that you want to create.

In this example, you create an account called Test Account.

Image Modified

You

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:

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

We click the Account tab and select the account that

you

we want to use with the Snap.
Image Modified

You save your changes and close the Snap. When you

When we validate the Snap, it creates an account in

your

the Salesforce instance and displays the following output:

Image Modified

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

You

We now want to delete the account that you just created. To do so,

you

we need to isolate the account ID from the REST Post Snap's output.

You

We use a Mapper for this task.
Image Modified

Upon validation, the Mapper Snap

offers

displays the following output:
Image Modified

You

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

:

.
Image Modified

When the Snap is executed, the account is deleted.
Image Modified

Downloads

Attachments

patterns	.slp, .zip

Insert excerpt

	REST Snap Pack
	REST Snap Pack
nopanel	true

Version	Old Version 37	New Version 38
Changes made by	Kalpana Malladi	Kalpana Malladi
Saved on	Jul 30, 2021	Aug 05, 2021

Versions Compared

Key

Overview

Prerequisites

Supported Features

Limitations and Known Issues

Snap Input and Output

Snap Settings

Troubleshooting

Examples

Creating and Deleting an Account in Salesforce Using REST Snaps

Downloads

See Also

Page Comparison

Versions Compared

Key

Overview

Prerequisites

Supported Features

Limitations and Known Issues

Snap Input and Output

Snap Settings

Troubleshooting

Examples

Creating and Deleting an Account in Salesforce Using REST Snaps

Downloads

See Also