Skip to content

Blueprint developer reference

Use Preview to inspect a plan and Run only after reviewing it. Run creates records in the early synchronous preview. Convert, background jobs and undo must not be inferred from the design roadmap.

Lists published blueprints for the requested table and audience without executing one. An empty list is a valid result.

Transport: unbound Dataverse action; JSON string Request in, JSON string Response out. pfx_ is a prefix token, not a literal deployment name. Read the calling conventions first.

Inner Request — illustrative
{
"table": "account"
}

table: optional logical table filter. blueprints contains published definitions and parameter metadata. author and administrator describe the caller’s capabilities.

Inner Response — illustrative
{
"blueprints": [],
"author": false,
"administrator": false
}

The schema requires Read privilege on pfx_BlueprintRun. Prefix tokens in table names resolve with the installed publisher. Record access, module role checks and input validation can further restrict the call. Do not interpret a missing execute privilege as anonymous or unrestricted access.

Handle a Dataverse fault separately from validation findings in the response. Test invalid input and the intended non-administrator role. Do not treat an empty result as a grant of access or a guarantee that no configuration exists.

Selected schema-declared registrations are shown for troubleshooting context. This is not a complete installed registration inventory. Preserve module-owned registrations; do not duplicate or disable them.

Owned registration Message / table Declared stage / mode
Blueprint: guard draft create Create · pfx_blueprint PreOperation / Sync
Blueprint: guard publication fields Update · pfx_blueprint PreOperation / Sync
Blueprint: protect blueprint deletion Delete · pfx_blueprint PreOperation / Sync

The full execution path may also include dynamically maintained registrations. Inspect the installed solution for exact stage, mode, filters and images before investigating interactions with your own plugins.

Confirm the installed operation name and permissions. Test representative data, empty results and denied access. Keep your integration in its own solution, and review contract changes before upgrading.

Administrator guide · Extension boundaries