In this article

Table of Contents

maxLevel	2
absoluteUrl	true

Overview

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 Description Default Value Example

Label

String

Insert excerpt

	File Writer
	File Writer
nopanel	true

N/A

Delete Identified Objects

Service URL

String

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/A

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

HTTP entity

String

Multiexcerpt include macro

name	HTTP_entity
page	REST Post

$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

Multiexcerpt include macro

name	Batch_Size
page	REST Patch

N/A

50

Show all headers

Check boxCheckbox

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

N/A

Trust all certificates

Check box

Multiexcerpt include macro

name	Trust_All_Certificates
page	REST Post

Deselected

N/A

Follow redirects

Check box

Multiexcerpt include macro

name	Follow_Redirects
page	REST Post

Selected

N/A

Query parameters

Fieldset

Multiexcerpt include macro

name	Query_Parameters_REST
page	REST Post

Query parameter

String

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

N/A

oauth2_access_token

Query parameter value

String

The Specify the value associated with the query parameter.

N/A

$account.access_token

HTTP header

Fieldset

Multiexcerpt include macro

name	HTTP_Header
page	REST Post

Key

String

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

N/A

User-Agent

Value

String

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

N/A

SnapLogic

Response entity type

String

Multiexcerpt include macro

name	Response_Entity_Type
page	REST Get

DEFAULT

TEXT

Read timeout

Integer

Multiexcerpt include macro

name	Read_Timeout
page	REST Post

900

1500

Connection timeout

Integer

Multiexcerpt include macro

name	Connection_Timeout
page	REST Post

30

45

Maximum request attempts

Integer

Multiexcerpt include macro

name	Maximum_Request_Attempts
page	REST Post

5

3

Retry request interval

Integer

Multiexcerpt include macro

name	Retry_Request_Interval
page	REST Post

3

10

Snap Execution

String

Multiexcerpt include macro

name	Execution_Detail_Write
page	SOAP Execute

Validate and Execute

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 the provided URI and parameters 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 an account in Salesforce and delete it using REST Snaps.

Note
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:
In the JSON Generator Snap, you enter a name for the account that you want to create. In this example, you create an account called Test Account.
You 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. You use the URL provided by Salesforce for managing the accounts available in your instance.
2. You use '$' in the HTTP entity field to specify that you want to use the string coming from the Snap upstream.
3. You add an HTTP header to the Snap, instructing Salesforce to read the document coming in as a JSON file.
You click the Account tab and select the account that you want to use with the Snap.

You save your changes and close the Snap. When you validate the Snap, it creates an account in your Salesforce instance and displays the following output:

The id field lists out the unique identifier of the new account created by the Snap.
You now want to delete the account that you just created. To do so, you need to isolate the account ID from the REST Post Snap's output. You use a Mapper for this task.

Upon validation, the Mapper Snap offers the following output:
You now use the REST Delete Snap to delete the newly-created account:

When the Snap is executed, the account is deleted.