Maintenance script: Operator API reference: multi-line response shape

2026-08-19T08:28:15Z

Operator API reference: multi-line response shape

← Older revision		Revision as of 08:28, 19 August 2026
Line 24:		Line 24:

	== Response ==		== Response ==
	Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape: <~~code~~>{"ok":true,"data":{"section":s,"id":n,"deleted":true,"cascaded":n}}</~~code~~>.		Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
			<pre>
			{
			"ok":true,
			"data":{
			"section":s,
			"id":n,
			"deleted":true,
			"cascaded":n
			}
			}
			</pre>

	== Errors ==		== Errors ==

Maintenance script: Operator API reference (generated from func=help)

2026-08-19T08:17:28Z

Operator API reference (generated from func=help)

New page

''newadmapi (Operator API) function. Available to: '''Operator, SuperRoot'''.''

== Description ==
Removes one row, addressed by id, within your tenant. When the row has dependants that would CASCADE, the first call is refused and states how many rows would go with it; repeat with confirm_cascade=true to proceed. A dependant that blocks the delete is named rather than surfaced as a constraint error.

{{Note|1=A '''generic verb''': it works over any section via the <code>section</code> parameter. Discover sections with [[OperatorAPI sections]] and a section's fields/capabilities with [[OperatorAPI options]].}}

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=delete
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>section</code> || string || Yes || — || The section key.
|-
| <code>id</code> || integer || Yes || — || The row to remove.
|-
| <code>confirm_cascade</code> || boolean || No || <code>false</code> || Proceed although dependent rows will be deleted too. <small>(Only needed when a previous call reported a cascade count)</small>
|}
== Example ==
<nowiki>POST https://host:port/newadm?func=delete&section=bonos&id=123</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape: <code>{"ok":true,"data":{"section":s,"id":n,"deleted":true,"cascaded":n}}</code>.

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI delete - Revision history

Maintenance script: Operator API reference: multi-line response shape

Maintenance script: Operator API reference (generated from func=help)