Intake developer reference
Integration boundary
Section titled “Integration boundary”Use the job lifecycle for staging, review and commit. Commit and undo require explicit business review; do not write job status or row decisions directly. Template packs are the configuration portability route.
pfx_IntakeGetCapabilities
Section titled “pfx_IntakeGetCapabilities”Reads features available to the caller; it does not import records. These booleans are illustrative for a restricted caller.
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.
Request
Section titled “Request”{}No inner request fields are required. canUseAdHocMappings and canDeleteJobs are capability flags, not a grant of record access.
Response
Section titled “Response”{ "canUseAdHocMappings": false, "canDeleteJobs": false}Permissions and failures
Section titled “Permissions and failures”The schema requires Create privilege on pfx_ImportJob. 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.
Plugin steps and customizations
Section titled “Plugin steps and customizations”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.
This module schema does not declare separate table-event steps. Its named Custom APIs dispatch to the module API plugin; this does not mean the module performs no server-side work.
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.
Before building against this preview
Section titled “Before building against this preview”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.