Tools Plugins

Plugins tools

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

33 tools · category token plugins · enable with DATAVERSE_TOOLS=plugins (unset enables every category)

Every tool returns JSON. Errors return {"error": true, "message": "..."}. Write tools require DATAVERSE_ALLOW_WRITE=true; delete tools require DATAVERSE_ALLOW_DELETE=true.

dataverse_create_plugin_assembly

Write · non-idempotent · category plugins

Upload a new plug-in assembly from base64-encoded DLL bytes.

Param	Type	Req	Default	Notes
dataverse_url	`str`	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
name	`str`	yes	—	Assembly name, typically the DLL base name e.g. 'MyOrg.Plugins' (min_len=1)
content	`str`	yes	—	Base64-encoded bytes of the strong-name-signed assembly DLL (min_len=1)
isolation_mode	`int`	no	`2`	1=None (full trust; not supported online), 2=Sandbox (default/recommended), 3=External
version	`str \| None`	no	`None`	Assembly version e.g. '1.0.0.0'. Derived from content if omitted.
culture	`str \| None`	no	`None`	Culture e.g. 'neutral'
public_key_token	`str \| None`	no	`None`	Public key token from the strong-name key
description	`str \| None`	no	`None`	Optional description for the assembly

Returns {"created": ..., "name": ..., "isolation_mode": ..., "location": ...}.

dataverse_create_plugin_package

Write · non-idempotent · category plugins

Upload a new NuGet-based plug-in package from base64-encoded .nupkg bytes.

Param	Type	Req	Default	Notes
dataverse_url	`str`	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
name	`str`	yes	—	Display name for the plug-in package (min_len=1)
unique_name	`str`	yes	—	Publisher-prefixed unique name e.g. 'yourprefix_MyPackage' (min_len=1)
content	`str`	yes	—	Base64-encoded bytes of the .nupkg file (min_len=1)
version	`str`	yes	—	Package version e.g. '1.0.0' (min_len=1)

Returns {"created": ..., "unique_name": ..., "location": ...}.

dataverse_create_plugin_step

Write · non-idempotent · category plugins

Register a processing step that runs a plug-in type on an SDK message.

Param	Type	Req	Default	Notes
dataverse_url	`str`	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
name	`str`	yes	—	Step name e.g. 'MyOrg.Plugins.ContactPlugin: Create of contact' (min_len=1)
plugin_type_id	`str`	yes	—	GUID of the plugintype handling this step
message_id	`str`	yes	—	GUID of the sdkmessage; resolve via dataverse_get_sdk_message
filter_id	`str \| None`	no	`None`	GUID of the sdkmessagefilter to scope to one entity; omit to register against all entities
stage	`int`	yes	—	Pipeline stage: 10 = pre-validation (outside the DB transaction), 20 = pre-operation (inside the DB transaction, before the main op), 40 = post-operation (after the main op). Not mutable after registration.
mode	`int`	yes	—	Execution mode: 0 = synchronous (runs in the caller's transaction), 1 = asynchronous (runs in a background System Job). Not mutable after registration.
rank	`int`	no	`1`	Execution order within the stage (lower runs first) (ge=1)
filtering_attributes	`str \| None`	no	`None`	Comma-separated logical names; step fires only when one of these attributes changes. Use for Update steps only.
supported_deployment	`int`	no	`0`	0=Server Only, 1=Outlook Client Only, 2=Both
async_auto_delete	`bool`	no	`False`	When True, automatically deletes completed async operations. Only relevant for asynchronous steps (mode=1).
configuration	`str \| None`	no	`None`	Unsecure configuration string passed to the plug-in constructor
description	`str \| None`	no	`None`	Optional step description

Returns {"created": ..., "name": ..., "stage": ..., "mode": ..., "location": ...}.

dataverse_create_plugin_step_image

Write · non-idempotent · category plugins

Register a pre/post entity image on a processing step.

Note: PostImage (image_type=1) is only valid for post-operation (stage=40) steps. entity_alias is the property-bag key used in plug-in code (e.g. 'PreImage').

Param	Type	Req	Default	Notes
dataverse_url	`str`	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
step_id	`str`	yes	—	GUID of the parent sdkmessageprocessingstep record
image_type	`int`	yes	—	0=PreImage, 1=PostImage, 2=Both
entity_alias	`str`	yes	—	Key used to access the image in the plug-in property bag e.g. 'PreImage' (min_len=1)
message_property_name	`str`	yes	—	Request message property the image is taken from, e.g. 'Target' for Create/Update (min_len=1)
name	`str \| None`	no	`None`	Image name; defaults to entity_alias if omitted
attributes	`str \| None`	no	`None`	Comma-separated logical names to include in the image; omit for all attributes
description	`str \| None`	no	`None`	Optional image description

Returns {"created": ..., "entity_alias": ..., "image_type": ..., "location": ...}.

dataverse_create_plugin_type

Write · non-idempotent · category plugins

Register a plug-in type (a .NET class) against an existing assembly.

Param	Type	Req	Default	Notes
dataverse_url	`str`	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
assembly_id	`str`	yes	—	GUID of the parent pluginassembly record
typename	`str`	yes	—	Fully-qualified .NET type name e.g. 'MyOrg.Plugins.ContactPlugin' (min_len=1)
friendly_name	`str \| None`	no	`None`	User-friendly name; defaults to typename if omitted
name	`str \| None`	no	`None`	Display name; defaults to typename if omitted
is_workflow_activity	`bool`	no	`False`	Whether this type is a custom workflow activity
workflow_activity_group_name	`str \| None`	no	`None`	Group name; only relevant for custom workflow activities

Returns {"created": ..., "typename": ..., "location": ...}.

dataverse_delete_plugin_assembly

Delete · non-idempotent · category plugins

Permanently delete a plug-in assembly record — this action cannot be undone.

Note: Fails while dependent plug-in types or steps exist.

Param	Type	Req	Default	Notes
dataverse_url	`str`	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
assembly_id	`str`	yes	—	GUID of the pluginassembly record to delete

Returns {"deleted": ..., "assembly_id": ...}.

dataverse_delete_plugin_package

Delete · non-idempotent · category plugins

Permanently delete a plug-in package and its extracted assemblies, types, and steps.

Note: This action cannot be undone and cascades to all dependent records.

Param	Type	Req	Default	Notes
dataverse_url	`str`	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
package_id	`str`	yes	—	GUID of the pluginpackage record to delete

Returns {"deleted": ..., "package_id": ...}.

dataverse_delete_plugin_step

Delete · non-idempotent · category plugins

Permanently delete an SDK message processing step — this action cannot be undone.

Param	Type	Req	Default	Notes
dataverse_url	`str`	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
step_id	`str`	yes	—	GUID of the sdkmessageprocessingstep record to delete

Returns {"deleted": ..., "step_id": ...}.

dataverse_delete_plugin_step_image

Delete · non-idempotent · category plugins

Permanently delete a plug-in step image — this action cannot be undone.

Param	Type	Req	Default	Notes
dataverse_url	`str`	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
image_id	`str`	yes	—	GUID of the sdkmessageprocessingstepimage record to delete

Returns {"deleted": ..., "image_id": ...}.

dataverse_delete_plugin_type

Delete · non-idempotent · category plugins

Permanently delete a plug-in type record — this action cannot be undone.

Note: Fails while dependent processing steps exist.

Param	Type	Req	Default	Notes
dataverse_url	`str`	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
plugin_type_id	`str`	yes	—	GUID of the plugintype record to delete

Returns {"deleted": ..., "plugin_type_id": ...}.