Actions41
- ── Framework ── Actions
- DataServer (Generic) Actions
- Employees (HR) Actions
- Payroll Actions
- Invoice (Stock) Actions
- Stock Movement Actions
- Accounts Payable/Receivable Actions
- Accounting Entry Actions
- Customers / Suppliers Actions
- Users Actions
- Companies Actions
- Enrollment (Education) Actions
DataServer (Generic) → Read Record
AI-generatedSummary
Read a single record from a specified TOTVS RM DataServer by applying an optional SQL filter to pinpoint the record.
Inputs
- DataServer Name (required) — Exact name of the DataServer to query, e.g., FopFuncData. Use the 'List Available DataServers' framework operation to find valid names.
- SQL Filter — Standard RM SQL filter string to narrow down the record selection, supporting operators like =, LIKE, AND, OR, IN. For example: CODCOLIGADA=1 AND CODSITUACAO='A'
- Select Fields — Comma-separated list of specific fields to retrieve. Leave empty to retrieve all fields.
- Company Code Override — Numeric company code to override the default from credentials. Use 0 to apply the credential's company code.
- RM Context — Additional RM context string in the format 'CODSISTEMA=S;CODUSUARIO=admin;CODFILIAL=1'. Defaults to credential context if left empty.
Output shape
a list containing one or more JSON objects representing the record(s) matching the filter criteria from the specified DataServer
The operation returns the parsed JSON response from the DataServer REST API, either a single record or an array of records matching the filter. If the filter matches multiple records, all matching records are returned. The select parameter limits the fields returned. If no records match, an empty array may be returned. Errors in the request or authentication will throw exceptions unless 'continueOnFail' is enabled, in which case error details are returned inline.
Examples
Example 1: Retrieve employee record with specific badge from FopFuncData DataServer specifying fields CHAPA and NOME
Set Resource to 'DataServer (Generic)', Operation to 'Read Record', DataServer Name to 'FopFuncData', SQL Filter to "CHAPA='000001'", and Select Fields to 'CHAPA,NOME'.