Versions Compared

Old Version 13

changes.mady.by.user Siddharth Menon

Saved on

compared with

New Version 14

changes.mady.by.user Leena Gopal

Saved on

Key

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

On n this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Write

Description:

Overview

This Snap invokes an Eloqua REST API Delete endpoint to delete an Eloqua object of a specified type.

  • Expected input: Each input document should specify the ID of an object of the given type to delete.  Any other content in an input document is ignored.
  • Expected output: The Snap outputs exactly one document for each object successfully deleted, specifying the ID of the deleted object.

    Image Added

Snap Type

The Eloqua Delete Snap is a Write-type Snap.

Prerequisites

:

[

None

]

Support

and limitations:

for Ultra Pipelines

Works in Ultra Task Pipelines.

Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Eloqua Account for more information.

Views:Input

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 

JSON Generator

This Snap has at most one document input view, which can be used to supply documents containing object IDs. The Snap will invoke the Eloqua endpoint once for each input document.

Output

Document


  • Min: 0

  • Max: 1

Mapper

This Snap has at most one document output view and produces one document in the view for each successful call to the Eloqua endpoint.
Error
This Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label

Handling

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 while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • 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

Field Name

Field Type

Field Dependency

Description

Label

Default Value: Eloqua Delete

Example:Create Accounts

String

N/A

Required. The 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.

Core object type


Default value: Accounts

Example: Contacts

Dropdown list

N/A

Required. The type of core object to delete. The options available include:

  • Accounts
  • Accounts 2.0
  • Account Fields
  • Account Fields 2.0
  • Campaigns
  • Campaigns 2.0
  • Contacts
  • Contacts 2.0
  • Contact Fields
  • Contact Fields 2.0
  • Contact Lists
  • Contact Lists 2.0
  • Contact Segments
  • Contact Segments 2.0
  • Content Sections
  • Content Sections 2.0
  • Custom Object Metadata
  • Custom Object Metadata 2.0
  • Emails
  • Emails 2.0
  • Email Folders
  • Email Folders 2.0
  • Email Footers
  • Email Footers 2.0
  • Email Groups
  • Email Groups 2.0
  • Email Headers
  • Email Headers 2.0
  • External Activities 2.0
  • External Assets 2.0
  • External Asset Types 2.0
  • Forms
  • Forms 2.0
  • Form Submission Data
  • Images 2.0
  • Imported Files 2.0
  • Landing Pages
  • Landing Pages 2.0
  • Microsites
  • Microsites 2.0
  • Option Lists
  • Option Lists 2.0


Note
All types without a specified version number are version 1.0.
Example: Contacts


ID

Default

value

Value:

 Accounts

 None

ID


Required. An identifier for the entity or an expression that evaluates to one.  When there is an input view, this should be an expression that specifies the path of the ID value in each input document, such as "$id".

Pass through

Default

value: [None] Multiexcerpt include macroname

Value: Deselected

Checkbox

N/A

Select this checkbox to enable the Snap to pass the input document to the output view under the key original.



Snap Execution

pageSOAP Execute

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

Examples

Image Removed


Dropdown list

N/A


Select one of the three modes in which the Snap executes. Available options are:

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


Examples

Image Added

Sample Input Document


Code Block
{
  "contactId": "49",
  ...all other fields ignored
}


Sample Output Document


Code Block
{
  "id": "49"
}

Sample Error Document


Code Block
{
  "reason": "Object Not Found (id: 49)",
  "status_code": 404,
  "original": {
    "contactId": "49",
    ...
  },
  "error": "The DELETE request failed",
  "url": "https://secure.p02.eloqua.com/API/REST/2.0/data/contact/49"
}

Insert excerpt
Eloqua Snap Pack
Eloqua Snap Pack
nopaneltrue