ByteChef LogoByteChef

Data Table

Work with ByteChef Data Tables and react to row changes.

Categories: Helpers

Type: dataTable/v1


Actions

Create Record(s)

Name: createRecords

Insert one or more new records to a table

Properties

NameLabelTypeDescriptionRequired
tableTableSTRINGtrue
recordsDYNAMIC_PROPERTIES
Depends On table
true

Example JSON Structure

{
  "label" : "Create Record(s)",
  "name" : "createRecords",
  "parameters" : {
    "table" : "",
    "records" : { }
  },
  "type" : "dataTable/v1/createRecords"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Delete Record(s)

Name: deleteRecords

Delete record(s) from a table

Properties

NameLabelTypeDescriptionRequired
tableTableSTRINGtrue
idsRecord IDsARRAY
Items [INTEGER($id)]
IDs of records to deletetrue

Example JSON Structure

{
  "label" : "Delete Record(s)",
  "name" : "deleteRecords",
  "parameters" : {
    "table" : "",
    "ids" : [ 1 ]
  },
  "type" : "dataTable/v1/deleteRecords"
}

Output

Type: OBJECT

Properties

NameTypeDescription
deletedCountINTEGER
deletedIdsARRAY
Items [INTEGER]

Output Example

{
  "deletedCount" : 1,
  "deletedIds" : [ 1 ]
}

Update Record

Name: updateRecord

Update values in an existing record

Properties

NameLabelTypeDescriptionRequired
tableTableSTRINGtrue
idRecord IDINTEGERtrue
valuesDYNAMIC_PROPERTIES
Depends On table
true

Example JSON Structure

{
  "label" : "Update Record",
  "name" : "updateRecord",
  "parameters" : {
    "table" : "",
    "id" : 1,
    "values" : { }
  },
  "type" : "dataTable/v1/updateRecord"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Get Record

Name: getRecord

Get single record by its id

Properties

NameLabelTypeDescriptionRequired
tableTableSTRINGtrue
idRecord IDINTEGERtrue

Example JSON Structure

{
  "label" : "Get Record",
  "name" : "getRecord",
  "parameters" : {
    "table" : "",
    "id" : 1
  },
  "type" : "dataTable/v1/getRecord"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Find Records

Name: findRecords

Find records in a table with filters

Properties

NameLabelTypeDescriptionRequired
tableTableSTRINGtrue
limitLimitINTEGERMaximum number of records to returnfalse
offsetOffsetINTEGERNumber of records to skipfalse

Example JSON Structure

{
  "label" : "Find Records",
  "name" : "findRecords",
  "parameters" : {
    "table" : "",
    "limit" : 1,
    "offset" : 1
  },
  "type" : "dataTable/v1/findRecords"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Clear Table

Name: clearTable

Delete all records from a table

Properties

NameLabelTypeDescriptionRequired
tableTableSTRINGtrue

Example JSON Structure

{
  "label" : "Clear Table",
  "name" : "clearTable",
  "parameters" : {
    "table" : ""
  },
  "type" : "dataTable/v1/clearTable"
}

Output

Type: OBJECT

Properties

NameTypeDescription
deletedCountINTEGER

Output Example

{
  "deletedCount" : 1
}

Triggers

Record Created

Name: recordCreated

Triggers when a new record is inserted into the selected table.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeDescriptionRequired
tableTableSTRINGSelect a Data Table.true

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "Record Created",
  "name" : "recordCreated",
  "parameters" : {
    "table" : ""
  },
  "type" : "dataTable/v1/recordCreated"
}

Record Updated

Name: recordUpdated

Triggers when a record is updated in the selected table.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeDescriptionRequired
tableTableSTRINGSelect a Data Table.true

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "Record Updated",
  "name" : "recordUpdated",
  "parameters" : {
    "table" : ""
  },
  "type" : "dataTable/v1/recordUpdated"
}

Record Deleted

Name: recordDeleted

Triggers when a record is deleted from the selected table.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeDescriptionRequired
tableTableSTRINGSelect a Data Table.true

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "Record Deleted",
  "name" : "recordDeleted",
  "parameters" : {
    "table" : ""
  },
  "type" : "dataTable/v1/recordDeleted"
}

How is this guide?

Last updated on

On this page