DocsWorkflowsComponentsAppapp:record:update

app:record:update

Applies a full replacement patch to an existing record and returns the updated record

Options

NameTypeDescription
org_idstringThe organization ID that scopes the operation
user_idstringThe caller's user ID recorded in the record history
schemastringThe name of the schema (database) that contains the table
tablestringThe name of the table that contains the record
idstringThe unique identifier of the record to update
recordRecordThe full replacement key-value data to apply

Outputs

NameTypeDescription
recordRecordThe updated record as persisted in the database

Example

name: Update a record
actions:
  - name: updated
    component: app:record:update
    vars:
      org_id: "{{ var.org_id }}"
      user_id: "{{ var.user_id }}"
      schema: content
      table: articles
      id: "{{ var.id }}"
      record:
        status: published

outputs:
  article: "{{ updated.record }}"