Dataverse icon

Dataverse

Consume Microsoft Dataverse API

Actions5

Overview

This node integrates with Microsoft Dataverse to perform operations on entity records within Dataverse tables. Specifically, the "Get Many" operation retrieves multiple records from a specified entity table, supporting advanced querying options such as filtering, selecting specific columns, sorting, expanding related data, and limiting the number of results.

Common scenarios for this node include:

  • Extracting lists of accounts, contacts, or opportunities based on specific criteria.
  • Retrieving subsets of data for reporting or further processing in workflows.
  • Fetching related entity data by expanding navigation properties.

For example, you could use this node to get all active accounts sorted by name, or retrieve contact records where the city equals "Seattle", including their primary contact details.

Properties

Name Meaning
Entity Table Name The logical name of the Dataverse entity table to query (e.g., accounts, contacts, opportunities).
Return All Whether to return all matching records or limit the output to a specified maximum number.
Limit Maximum number of records to return if "Return All" is false. Minimum value is 1.
Options - Filter OData $filter query option to filter results (e.g., name eq 'Contoso').
Options - Select Comma-separated list of columns to retrieve (e.g., name,accountnumber,revenue).
Options - Order By OData $orderby query option to sort results (e.g., name asc).
Options - Expand OData $expand query option to include related entities (e.g., primarycontactid($select=fullname)).
Options - Top Maximum number of records to return per request (used internally when fetching all records).

Output

The node outputs an array of JSON objects, each representing a single entity record retrieved from the specified Dataverse table. Each object contains the fields requested via the Select option or all fields if none specified.

If related data is included via the Expand option, those related entities appear nested within the main record's JSON structure.

No binary data output is produced by this operation.

Example output item (simplified):

{
  "name": "Contoso Ltd",
  "accountnumber": "12345",
  "revenue": 1000000,
  "primarycontactid": {
    "fullname": "John Doe"
  }
}

Dependencies

  • Requires an API key credential for authenticating with Microsoft Dataverse.
  • The node uses the Microsoft Dataverse Web API endpoints.
  • Proper permissions on the Dataverse environment are necessary to read entity records.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing entity table name will cause errors.
    • Incorrect OData query syntax in filter, orderby, or expand options can lead to API errors.
    • Insufficient permissions may result in authorization errors.
    • Requesting too many records without pagination may cause timeouts or throttling.
  • Error messages:

    • "Resource not found": Check that the entity table name is correct.
    • "Invalid filter expression": Verify the OData filter syntax.
    • "Unauthorized" or "Access denied": Ensure API credentials have proper access rights.
    • "Request timeout": Try reducing the limit or enabling pagination by setting "Return All" to true.

Links and References

Discussion