Dataverse icon

Dataverse

Consume Microsoft Dataverse API

Actions5

Overview

This node interacts with Microsoft Dataverse to retrieve a single entity record by its unique identifier (GUID). It is useful when you need to fetch detailed information about a specific record from a Dataverse table, such as an account, contact, or opportunity. For example, you might use this node to get the details of a customer account before processing an order or to retrieve contact information for sending personalized communications.

Properties

Name Meaning
Entity Table Name The logical name of the Dataverse entity table to query (e.g., accounts, contacts, opportunities).
Record ID The unique identifier (GUID) of the record to retrieve.
Options Additional OData query options to customize the retrieval:
- Filter OData $filter query option to filter results (not typically used in single record get).
- Select Comma-separated list of columns to retrieve from the record.
- Order By OData $orderby query option to sort results (not typically used in single record get).
- Expand OData $expand query option to include related data (e.g., related entities or lookup fields).

Output

The output is a JSON object representing the retrieved entity record with the requested fields and any expanded related data included. The structure corresponds directly to the Dataverse entity schema and contains all selected attributes of the record.

Example output JSON snippet:

{
  "accountid": "00000000-0000-0000-0000-000000000001",
  "name": "Contoso Ltd.",
  "revenue": 1000000,
  "primarycontactid": {
    "fullname": "John Doe"
  }
}

No binary data output is produced by this operation.

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.
  • Network connectivity to the Dataverse service endpoint.

Troubleshooting

  • Record Not Found: If the specified Record ID does not exist in the given entity table, the node will throw an error. Verify the GUID and entity table name.
  • Permission Denied: Insufficient permissions or invalid API credentials will cause authentication errors. Ensure the API key has read access to the target entity.
  • Invalid Query Options: Incorrectly formatted OData options (e.g., malformed $select or $expand) may result in API errors. Double-check syntax and supported fields.
  • Network Issues: Connectivity problems can cause timeouts or failures. Confirm network access to the Dataverse endpoint.

Links and References

Discussion