Create Entity Record

Creates a record of a Data Hub entity in the job's workspace.

Behaviour

Risk: Low · Idempotent: No · Safe to retry: No · Recovery: Checks its own result, then replays if needed

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

Properties#

Input#

Entity#

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

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

Values#

Values · IDictionary<String, Object> · Optional · Default: Not specified in package metadata

The field values by field name. A decimal, date or datetime value is sent in its field's form.

Values JSON#

ValuesJson · String · Optional · Default: Not specified in package metadata

The field values as a JSON object, such as {"invoiceNumber":"INV-24","amount":"99.95"}. Use instead of Values.

Options#

Idempotency Key#

IdempotencyKey · String · Optional · Default: Not specified in package metadata

Makes a repeated create return the first record instead of a second one: the same key with the same values within 24 hours. A key reused with other values faults with dh_idempotency_key_reused.

At most 100 characters.

Output#

Record#

Record · Dictionary<String, Object> · Output

The record as stored: id, revision, createdAt, createdBy, updatedAt, updatedBy and every field.

Record Id#

RecordId · String · Output

The new record's id.

Revision#

Revision · Int32 · Output

The record's revision, 1 for a new record.

Rules#

  • Set only one of: Values, Values JSON.

Retry and risk#

This activity is not marked safe to retry: if it fails partway, check whether its work already happened before running it again. 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.

Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Data Hub. Keywords: data hub, data service, entity, record, create, add, insert, row, orchestrator.

Properties

Input

Options

Output

Rules

Retry and risk

Related activities