Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-10-05 14:46:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
bcquality/microsoft/knowledge/style/api-page-delayedinsert-true.md
Jesper Schulz-Wedde 2b5550c346
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Details
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Details
Validate frontmatter and structure / validate (push) Has been cancelled
Details
Improve partner onboarding and documentation navigation (#174) 
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules.

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-09 17:31:03 +02:00

1.6 KiB
Raw Permalink Blame History

bc-version domain keywords technologies countries application-area
all
style
api-page
delayedinsert
insert-trigger
validation
al
w1
all

Set DelayedInsert = true on API pages

Description

On a normal page, DelayedInsert = false is the default: the record is inserted into the table as soon as the user enters the first field, and subsequent fields are written via Modify triggers. That model does not work for an API endpoint, where the consumer sends a complete JSON payload in a single request and expects exactly one Insert to fire with all fields already populated. DelayedInsert = true defers the insert until every field on the page has been assigned, so the OnInsert trigger runs once with the full record and OnValidate triggers on individual fields run in a predictable order. The convention is that API pages always set DelayedInsert = true.

Best Practice

Declare DelayedInsert = true on every page with PageType = API. The setting plays well with Modify(true) and Insert(true) calls inside OnInsert and avoids the half-populated record states that otherwise reach validation logic.

See sample: api-page-delayedinsert-true.good.al.

Anti Pattern

Omitting DelayedInsert (which defaults to false) on an API page. Validation triggers fire on a partially populated record, mandatory-field errors come back to the caller for fields the JSON payload was about to supply, and the API surface produces failures that have no analogue in the UI page model.

See sample: api-page-delayedinsert-true.bad.al.