Delete Entity Record

Deletes a Data Hub record. The entity must allow deletes from automations.

Behaviour

Risk: Medium · Idempotent: Yes · Safe to retry: Yes · Recovery: Replayed after a crash

Package Orchestrator activities VeloPhex.Orchestrator.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.orchestrator.dataHub.deleteRecord

Properties#

Input#

Entity#

Entity · String · Required · Default: Not specified in package metadata

The entity's name in the job's workspace, such as Invoice.

Record Id#

RecordId · String · Required · Default: Not specified in package metadata

The record's id, as a create or a query returned it.

Options#

Ignore Missing#

IgnoreMissing · Boolean · Optional · Default: False

Succeed when there is no record with the id, instead of failing with dh_record_not_found.

Output#

Deleted#

Deleted · Boolean · Output

False when there was no record to delete and Ignore Missing is set.

Retry and risk#

This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Related activities#

• Create Entity Record
• Create or Update Entity Record
• Get Entity Record
• Query Entity Records
• Update Entity Record

Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Data Hub. Keywords: data hub, data service, entity, record, delete, remove, orchestrator.

Properties

Input

Options

Output

Retry and risk

Related activities