Set Form Layout
set_form_layoutReplace a form section's layout with the complete ordered element list read from get_form_layout, using the working update set; sections with annotations, charts, or embedded lists are refused.
Instructions
Replace one form section's layout with the whole new element list, as the Form Layout page saves it, captured and read back. Read it first with get_form_layout and send every element to keep. The update set must be the working set. Refused for sections holding annotations, charts or embedded lists.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | The record's application: its scope name (e.g. "x_acme_app"), or "global". Give this or scope_id. | |
| section | Yes | The sys_ui_section sys_id. | |
| elements | Yes | The whole new layout, in order, as get_form_layout returns it. | |
| instance | No | The ServiceNow instance auth alias to connect to. This is the alias configured via `snc configure` (e.g., "myinstance", "prod", "test"). The user will typically refer to this by name when saying things like "on my myinstance instance". If not provided, falls back to the SN_AUTH_ALIAS environment variable. | |
| scope_id | No | The record's application by sys_scope sys_id, instead of scope. | |
| update_set | Yes | sys_id of an In progress update set of that application (create_update_set). The capture is verified there; for adding a column and for layout saves it must also be the working set (set_current_update_set). | |
| acknowledge_upgrade_skip | No | Only for an installed Store application, and only after the user has reviewed the change: upgrades of that application then skip this file until the customization is reviewed. |