Update Entity Record
Changes the given fields of a Data Hub record and leaves the others as they are.
Behaviour
Risk: Low · 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.updateRecord
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.
Values#
Values · IDictionary<String, Object> · Optional · Default: Not specified in package metadata
Only the fields to change, by field name; a null value clears a field.
Values JSON#
ValuesJson · String · Optional · Default: Not specified in package metadata
The fields to change as a JSON object, such as {"status":"paid"}. Use instead of Values.
Options#
Revision#
Revision · Int32 · Optional · Default: 0
The revision the record must still have, from Get Entity Record; a record changed since faults with dh_revision_conflict. 0 overwrites the fields whatever changed.
Must be between 0 and 2147483647.
Output#
Record#
Record · Dictionary<String, Object> · Output
The record after the change: id, revision, createdAt, createdBy, updatedAt, updatedBy and every field.
New Revision#
NewRevision · Int32 · Output
The record's revision after the change.
Rules#
- Set only one of: Values, Values JSON.
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
- Delete Entity Record
- Get Entity Record
- Query Entity Records
Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Data Hub. Keywords: data hub, data service, entity, record, update, change, edit, patch, orchestrator.
Properties
Input
Options
Output
Rules
Retry and risk
Related activities