Tool Index

Tool index

This page is generated from the code by scripts/gen_wiki_tools.py — do not edit by hand.

All 200 tools, alphabetically. Use your browser's find (Ctrl+F) to locate a tool, then follow the link for its parameters.

Home

Tools by category

Category	DATAVERSE_TOOLS token	Page	Tools
Core	core	Tools-Core	24
Schema	schema	Tools-Schema	35
Solutions	solutions	Tools-Solutions	21
Plugins	plugins	Tools-Plugins	33
Security	security	Tools-Security	22
Custom APIs	customapis	Tools-Custom-APIs	13
Apps	apps	Tools-Apps	10
Variables	variables	Tools-Variables	8
Flows	flows	Tools-Flows	8
Views	views	Tools-Views	7
Forms	forms	Tools-Forms	6
Connections	connections	Tools-Connections	5
Web Resources	webresources	Tools-Web-Resources	5
Jobs	jobs	Tools-Jobs	3
Total			200

core is always enabled. Write tools also require DATAVERSE_ALLOW_WRITE=true; delete tools require DATAVERSE_ALLOW_DELETE=true.

All tools

Tool	Category	Access	Purpose
dataverse_activate_process	Flows	Write	Activate a classic process (workflow, business rule, action, or BPF).
dataverse_add_app_components	Apps	Write	Add components (tables, forms, views, charts, BPFs) to a model-driven app.
dataverse_add_choice_option	Schema	Write	Add a new option to a global or local (column-specific) choice.
dataverse_add_component_to_solution	Solutions	Write	Add an existing component to a Dataverse solution via AddSolutionComponent.
dataverse_add_form_control	Forms	Write	Add a column control to a Dataverse model-driven app form.
dataverse_add_team_members	Security	Write	Add one or more system users to a Dataverse team.
dataverse_add_view_column	Views	Write	Add a single column to a Dataverse view's FetchXml and LayoutXml.
dataverse_aggregate_table	Core	Read	Group and aggregate Dataverse records with an OData $apply expression.
dataverse_analyze_dependencies	Solutions	Read	Analyze dependencies for a Dataverse solution component.
dataverse_assign_app_role	Apps	Delete	Associate or disassociate a Dataverse security role with a model-driven app.
dataverse_assign_security_role	Security	Write	Assign a security role to a user or team via the Web API $ref association.
dataverse_associate_records	Core	Write	Associate two Dataverse records via a collection-valued navigation property.
dataverse_audit_user_access	Security	Read	Return a composite access report for a Dataverse system user.
dataverse_batch_disable_cloud_flows	Flows	Write	Disable multiple cloud flows in a single $batch request for improved performance.
dataverse_batch_enable_cloud_flows	Flows	Write	Enable multiple cloud flows in a single $batch request for improved performance.
dataverse_bulk_upsert	Core	Write	Upsert many records in one call using OData $batch PATCH operations.
dataverse_cancel_async_operation	Jobs	Write	Cancel a running or waiting asyncoperation (system job).
dataverse_check_relationship_eligibility	Schema	Read	Pre-validate whether a table supports a specific relationship role before creating a relationship.
dataverse_clone_solution_as_patch	Solutions	Write	Clone a solution as a patch via the unbound CloneAsPatch action.
dataverse_count_records	Core	Read	Count records in a table (optionally filtered) and return only the integer total.
dataverse_create_alternate_key	Schema	Write	Create an alternate key on a Dataverse table.
dataverse_create_app	Apps	Write	Create a new model-driven app (AppModule) in a Dataverse environment.
dataverse_create_choice	Schema	Write	Create a new GLOBAL choice (option set) that can be reused across multiple columns.
dataverse_create_column	Schema	Write	Add a new typed column (attribute) to a Dataverse table.
dataverse_create_connection_reference	Connections	Write	Create a new connection reference in the Dataverse environment.
dataverse_create_custom_api	Custom APIs	Write	Create a new Custom API record and return its GUID.
dataverse_create_custom_api_request_parameter	Custom APIs	Write	Create a new request parameter for a Custom API and return its GUID.
dataverse_create_custom_api_response_property	Custom APIs	Write	Create a new response property for a Custom API and return its GUID.
dataverse_create_environment_variable	Variables	Write	Create a new environment variable definition and optional initial value.
dataverse_create_environment_variable_value	Variables	Write	Create a new environment variable value record bound to a definition.
dataverse_create_many_to_many_relationship	Schema	Write	Create an N:N relationship and its intersect (junction) table between two tables.
dataverse_create_multi_table_lookup	Schema	Write	Create a polymorphic (multi-table) lookup column that can reference multiple tables.
dataverse_create_one_to_many_relationship	Schema	Write	Create a 1:N relationship between two tables and its lookup column on the referencing side.
dataverse_create_plugin_assembly	Plugins	Write	Upload a new plug-in assembly from base64-encoded DLL bytes.
dataverse_create_plugin_package	Plugins	Write	Upload a new NuGet-based plug-in package from base64-encoded .nupkg bytes.
dataverse_create_plugin_step	Plugins	Write	Register a processing step that runs a plug-in type on an SDK message.
dataverse_create_plugin_step_image	Plugins	Write	Register a pre/post entity image on a processing step.
dataverse_create_plugin_type	Plugins	Write	Register a plug-in type (a .NET class) against an existing assembly.
dataverse_create_publisher	Solutions	Write	Create a Dataverse publisher that owns the customization prefix for solutions.
dataverse_create_record	Core	Write	Create a single record in any Dataverse table and return the new record's id.
dataverse_create_solution	Solutions	Write	Create a new Dataverse solution scoped to a publisher.
dataverse_create_table	Schema	Write	Create a new custom table (entity) in the Dataverse environment.
dataverse_create_view	Views	Write	Create a new saved view (savedquery) for a Dataverse table.
dataverse_create_web_resource	Web Resources	Write	Create a webresource record and return the new record's GUID.
dataverse_deactivate_process	Flows	Write	Deactivate a classic process (workflow, business rule, action, or BPF).
dataverse_delete_alternate_key	Schema	Delete	Delete an alternate key from a Dataverse table by its logical name.
dataverse_delete_and_promote_solution	Solutions	Delete	Apply a solution upgrade by promoting the holding _Upgrade solution and deleting obsolete components via DeleteAndPromote.
dataverse_delete_choice	Schema	Delete	Delete a GLOBAL choice (option set) by logical name.
dataverse_delete_choice_option	Schema	Delete	Remove a specific option value from a global or local choice.
dataverse_delete_column	Schema	Delete	Permanently delete a custom column and all its data from a table — irreversible.
dataverse_delete_connection_reference	Connections	Delete	Delete a connection reference from the Dataverse environment.
dataverse_delete_custom_api	Custom APIs	Delete	Permanently delete a Custom API record by its GUID.
dataverse_delete_custom_api_request_parameter	Custom APIs	Delete	Permanently delete a Custom API request parameter by its GUID.
dataverse_delete_custom_api_response_property	Custom APIs	Delete	Permanently delete a Custom API response property by its GUID.
dataverse_delete_environment_variable	Variables	Delete	Delete an environment variable definition, its current value, or both.
dataverse_delete_environment_variable_value	Variables	Delete	Delete an environment variable value record (reset to default).
dataverse_delete_plugin_assembly	Plugins	Delete	Permanently delete a plug-in assembly record — this action cannot be undone.
dataverse_delete_plugin_package	Plugins	Delete	Permanently delete a plug-in package and its extracted assemblies, types, and steps.
dataverse_delete_plugin_step	Plugins	Delete	Permanently delete an SDK message processing step — this action cannot be undone.
dataverse_delete_plugin_step_image	Plugins	Delete	Permanently delete a plug-in step image — this action cannot be undone.
dataverse_delete_plugin_type	Plugins	Delete	Permanently delete a plug-in type record — this action cannot be undone.
dataverse_delete_record	Core	Delete	Permanently delete a single Dataverse record by GUID — this action cannot be undone.
dataverse_delete_relationship	Schema	Delete	Delete a custom relationship by MetadataId — permanent; deletes the associated lookup column for 1:N.
dataverse_delete_table	Schema	Delete	Permanently delete a custom table and all its records — irreversible.
dataverse_delete_web_resource	Web Resources	Delete	Permanently delete a webresource record by its GUID.
dataverse_disable_cloud_flow	Flows	Write	Disable a single cloud flow (set statecode=0, statuscode=1).
dataverse_disassociate_records	Core	Delete	Remove an existing association between two Dataverse records.
dataverse_enable_cloud_flow	Flows	Write	Enable a single cloud flow (set statecode=1, statuscode=2).
dataverse_execute_batch	Core	Write	Execute bulk or atomic multi-operation reads and writes via the OData $batch endpoint.
dataverse_execute_fetchxml	Core	Read	Execute a FetchXML query against a Dataverse table and return matching records.
dataverse_export_solution	Solutions	Read	Export a Dataverse solution as a base64-encoded zip.
dataverse_get_app	Apps	Read	Get a model-driven app's properties and its current component list.
dataverse_get_async_operation	Jobs	Read	Retrieve a single asyncoperation (system job) record by its GUID.
dataverse_get_attribute_change_history	Security	Read	Retrieve the audit trail for ONE COLUMN of ONE RECORD — who changed this field.
dataverse_get_audit_details	Security	Read	Retrieve full details from a single audit record.
dataverse_get_choice	Schema	Read	Get one GLOBAL choice (option set) — all option values, codes, and labels — by name or MetadataId.
dataverse_get_cloud_flows	Flows	Read	List cloud flows in the Dataverse environment, optionally scoped to a solution.
dataverse_get_column	Schema	Read	Get full metadata for a single column on a Dataverse table, including type-specific properties.
dataverse_get_connection_reference	Connections	Read	Get a single connection reference by GUID or logical name.
dataverse_get_custom_api	Custom APIs	Read	Retrieve a single Custom API record by its GUID, including expanded request parameters and response properties.
dataverse_get_entity_sets	Core	Read	List OData EntitySet names from the Dataverse service document.
dataverse_get_environment_variable_values	Variables	Read	Get environment variable value record(s).
dataverse_get_environment_variables	Variables	Read	List environment variable definitions with their current values.
dataverse_get_form	Forms	Read	Get a single Dataverse form's layout parsed as a structured JSON object.
dataverse_get_import_job	Solutions	Read	Retrieve a single importjob record by its GUID to check import progress.
dataverse_get_import_job_results	Solutions	Read	Answer "WHY did this solution import fail?" — the readable import results.
dataverse_get_organization_info	Core	Read	Fingerprint a Dataverse environment: server version, organization identity, endpoints.
dataverse_get_plugin_assembly	Plugins	Read	Retrieve a single plug-in assembly record by its GUID.
dataverse_get_plugin_package	Plugins	Read	Retrieve a single plug-in package record by its GUID.
dataverse_get_plugin_step	Plugins	Read	Retrieve a single SDK message processing step record by its GUID.
dataverse_get_plugin_step_image	Plugins	Read	Retrieve a single plug-in step image record by its GUID.
dataverse_get_plugin_trace_log_setting	Plugins	Read	Get the current plug-in trace log setting for the Dataverse organization.
dataverse_get_plugin_type	Plugins	Read	Retrieve a single plug-in type record by its GUID.
dataverse_get_record	Core	Read	Retrieve a single Dataverse record by its GUID.
dataverse_get_relationship	Schema	Read	Get full metadata for a single relationship by schema name — cascade configuration and navigation properties.
dataverse_get_role_privileges	Security	Read	Answer "what can this security role actually DO?" — list a role's privileges.
dataverse_get_sdk_message	Plugins	Read	Resolve an SDK message (e.g.
dataverse_get_sdk_message_filter	Plugins	Read	Resolve the filter that scopes an SDK message to one entity — returns the sdkmessagefilterid.
dataverse_get_security_role	Security	Read	Retrieve a single Dataverse security role by its GUID.
dataverse_get_setting	Core	Read	Read one setting's FINAL COMPUTED value for this environment.
dataverse_get_solution	Solutions	Read	Retrieve a single Dataverse solution by its unique name or GUID.
dataverse_get_solution_history	Solutions	Read	Retrieve a single solution history record by its GUID.
dataverse_get_table_metadata	Schema	Read	Get schema details for a single Dataverse table by logical name.
dataverse_get_team	Security	Read	Retrieve a single Dataverse team by its GUID.
dataverse_get_team_privileges	Security	Read	Answer "what can this TEAM actually DO?" — list a team's privileges.
dataverse_get_total_record_counts	Core	Read	Get approximate row counts for many Dataverse tables in one round trip.
dataverse_get_user	Security	Read	Retrieve a single Dataverse system user by their GUID.
dataverse_get_valid_relationship_entities	Schema	Read	List WHICH tables may take part in a relationship — the enumeration, before you pick a target.
dataverse_get_view	Views	Read	Get a single Dataverse view's layout as structured JSON.
dataverse_get_web_resource	Web Resources	Read	Retrieve a single webresource record by its GUID.
dataverse_import_solution	Solutions	Write	Import a Dataverse solution asynchronously via ImportSolutionAsync.
dataverse_is_component_customizable	Schema	Read	Check whether a solution component can be customized BEFORE trying to edit it.
dataverse_list_alternate_keys	Schema	Read	List alternate keys (EntityKeyMetadata) defined on a Dataverse table.
dataverse_list_apps	Apps	Read	List model-driven apps (AppModule records) in a Dataverse environment.
dataverse_list_async_operations	Jobs	Read	List asyncoperation (system job) records in the Dataverse environment.
dataverse_list_audit	Security	Read	Query the audit table with optional OData filters.
dataverse_list_business_units	Security	Read	List business units in the Dataverse environment.
dataverse_list_choice_column_options	Schema	Read	Get option values and labels for a Picklist or MultiSelectPicklist column's LOCAL option set.
dataverse_list_choices	Schema	Read	List GLOBAL choice (option set) definitions in the Dataverse environment.
dataverse_list_columns	Schema	Read	List column (attribute) definitions for a Dataverse table.
dataverse_list_connection_references	Connections	Read	List connection references in the Dataverse environment.
dataverse_list_custom_api_request_parameters	Custom APIs	Read	List request parameter records for a Custom API.
dataverse_list_custom_api_response_properties	Custom APIs	Read	List response property records for a Custom API.
dataverse_list_custom_apis	Custom APIs	Read	List Custom API records in the Dataverse environment.
dataverse_list_environments	Core	Read	List Power Platform environments available to the authenticated user.
dataverse_list_forms	Forms	Read	List model-driven app forms registered in the Dataverse environment.
dataverse_list_import_jobs	Solutions	Read	List importjob records, optionally filtered by solution unique name.
dataverse_list_languages	Schema	Read	List an environment's language codes (LCIDs) — which are usable, which are merely installed.
dataverse_list_plugin_assemblies	Plugins	Read	List plug-in assemblies registered in the environment, optionally filtered.
dataverse_list_plugin_packages	Plugins	Read	List NuGet-based plug-in packages registered in the environment.
dataverse_list_plugin_step_images	Plugins	Read	List plug-in step images (pre/post entity snapshots) registered against steps.
dataverse_list_plugin_steps	Plugins	Read	List SDK message processing steps registered in the environment.
dataverse_list_plugin_trace_logs	Plugins	Read	List plug-in trace log records with optional filters.
dataverse_list_plugin_type_statistics	Plugins	Read	List runtime performance statistics for Dataverse plug-in types.
dataverse_list_plugin_types	Plugins	Read	List plug-in types (.NET classes) registered in the environment.
dataverse_list_privileges	Security	Read	List the privileges DEFINED in the environment — the catalogue of what CAN be granted.
dataverse_list_processes	Flows	Read	List classic processes (workflows, business rules, actions, BPFs) from the workflow entity.
dataverse_list_relationships	Schema	Read	List relationship definitions for a table (OneToMany, ManyToOne, ManyToMany) or the whole environment.
dataverse_list_sdk_message_filters	Plugins	Read	List SDK message filters showing which entities support each message.
dataverse_list_sdk_messages	Plugins	Read	List SDK messages — the catalog of operations plug-in steps can intercept.
dataverse_list_security_roles	Security	Read	List security roles in the Dataverse environment.
dataverse_list_shared_principals	Security	Read	Answer "WHO has this record because it was SHARED with them?".
dataverse_list_solution_components	Solutions	Read	List components within a Dataverse solution, with human-readable type names.
dataverse_list_solution_histories	Solutions	Read	List solution history records from msdyn_solutionhistories.
dataverse_list_solutions	Solutions	Read	List solutions in the Dataverse environment with name, version, and managed status.
dataverse_list_tables	Schema	Read	List tables (entities) in the Dataverse environment with their logical names and display names.
dataverse_list_teams	Security	Read	List teams in the Dataverse environment.
dataverse_list_users	Security	Read	List system users (systemusers) in the Dataverse environment.
dataverse_list_views	Views	Read	List saved views (savedqueries) registered in the Dataverse environment.
dataverse_list_web_resources	Web Resources	Read	List webresource records in the Dataverse environment.
dataverse_merge_records	Core	Write	Merge a subordinate record into a target record for account, contact, lead, or incident.
dataverse_publish_app	Apps	Write	Publish a model-driven app to make it visible to users.
dataverse_publish_customizations	Schema	Write	Publish Dataverse schema customizations to make changes visible in model-driven apps.
dataverse_query_table	Core	Read	Query records from a Dataverse table with OData filtering, ordering, and expansion.
dataverse_remove_app_components	Apps	Write	Remove components from a model-driven app.
dataverse_remove_component_from_solution	Solutions	Delete	Remove a component from a Dataverse solution via RemoveSolutionComponent.
dataverse_remove_form_control	Forms	Write	Remove a column control from a Dataverse model-driven app form.
dataverse_remove_security_role	Security	Delete	Remove a security role from a user or team via the Web API $ref disassociation.
dataverse_remove_team_members	Security	Delete	Remove one or more system users from a Dataverse team.
dataverse_remove_view_column	Views	Write	Remove a single column from a Dataverse view's FetchXml and LayoutXml.
dataverse_reorder_choice_options	Schema	Write	Reorder all options of a global or local choice by supplying the full ordered list of values.
dataverse_retrieve_access_origin	Security	Read	Answer "WHY does this principal have access to this record?".
dataverse_retrieve_principal_access	Core	Read	Return the access rights a system user has to a specific Dataverse record.
dataverse_retrieve_record_change_history	Security	Read	Retrieve the full audit change history for a specific record.
dataverse_retrieve_unpublished	Core	Read	Read the UNPUBLISHED (draft) definition of one customization record.
dataverse_retrieve_user_privileges	Core	Read	Retrieve all security privileges assigned to a system user via their roles.
dataverse_set_app_sitemap	Apps	Write	Create or replace the navigation sitemap for a model-driven app.
dataverse_set_formxml	Forms	Write	Replace a Dataverse form's FormXml with a complete new XML string, then publish.
dataverse_set_plugin_trace_log_setting	Plugins	Write	Enable or disable plug-in trace logging for the Dataverse organization.
dataverse_set_user_state	Security	Write	Enable or disable a Dataverse system user.
dataverse_stage_and_upgrade_solution	Solutions	Delete	Perform a single-step true solution upgrade via StageAndUpgradeAsync.
dataverse_swap_flow_connection_reference	Core	Write	Swap a connection reference logical name inside a cloud flow's clientdata.
dataverse_update_app	Apps	Write	Update a model-driven app's name or description.
dataverse_update_choice	Schema	Write	Update a global choice's metadata — the metadata API requires a full PUT, not a partial update.
dataverse_update_choice_option	Schema	Write	Update the display label of an existing option in a global or local choice.
dataverse_update_column	Schema	Write	Update a column's metadata — the metadata API requires a full PUT, not a partial update.
dataverse_update_connection_reference	Connections	Write	Update a connection reference — most commonly used to assign a connection.
dataverse_update_custom_api	Custom APIs	Write	Partially update a Custom API record (PATCH) — only mutable fields.
dataverse_update_custom_api_request_parameter	Custom APIs	Write	Partially update a Custom API request parameter (PATCH) — mutable fields only.
dataverse_update_custom_api_response_property	Custom APIs	Write	Partially update a Custom API response property (PATCH) — mutable fields only.
dataverse_update_environment_variable	Variables	Write	Update an environment variable definition and/or its current value.
dataverse_update_environment_variable_value	Variables	Write	Update an existing environment variable value record.
dataverse_update_plugin_assembly	Plugins	Write	Update an existing plug-in assembly — most often to re-deploy new DLL bytes.
dataverse_update_plugin_package	Plugins	Write	Update a plug-in package — re-upload new .nupkg content or bump the version.
dataverse_update_plugin_step	Plugins	Write	Update an SDK message processing step, including enabling or disabling it.
dataverse_update_plugin_step_image	Plugins	Write	Update a plug-in step image's alias, property name, or attribute filter.
dataverse_update_plugin_type	Plugins	Write	Update mutable display fields on a plug-in type record.
dataverse_update_publisher	Solutions	Write	Update a Dataverse publisher's display name, customization prefix, or option value prefix.
dataverse_update_record	Core	Write	Partially update a single Dataverse record via PATCH — only supplied columns change.
dataverse_update_relationship	Schema	Write	Update a relationship's cascade behavior or configuration — the metadata API requires a full PUT.
dataverse_update_solution	Solutions	Write	Update a Dataverse solution's display name, description, or publisher.
dataverse_update_solution_version	Solutions	Write	Update a Dataverse solution's version string only (e.g., '1.0.0.1' → '1.0.0.2').
dataverse_update_table	Schema	Write	Update a table's display name or description via a full PUT replacement.
dataverse_update_view	Views	Write	Update an existing Dataverse view's columns, sort, filters, or name.
dataverse_update_web_resource	Web Resources	Write	Partially update a webresource record (PATCH) — only supplied fields change.
dataverse_validate_app	Apps	Read	Validate a model-driven app and return all errors and warnings.
dataverse_validate_fetchxml	Core	Read	Check a FetchXML query for problems and performance warnings WITHOUT running it.
dataverse_validate_formxml	Forms	Read	Validate FormXml against structural rules derived from the FormXml XSD.
dataverse_validate_view	Views	Read	Validate a Dataverse view's FetchXml and LayoutXml against 16 structural rules.
dataverse_whoami	Core	Read	Return the authenticated caller's identity from the Dataverse WhoAmI endpoint.