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

2026-08-19T08:28:17Z

Operator API reference: multi-line response shape

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

	== 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":{"row":{...declared fields...}}}</~~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":{
			"row":{
			...declared fields...
			}
			}
			}
			</pre>

	== Errors ==		== Errors ==

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

2026-08-19T08:17:30Z

Operator API reference (generated from func=help)

New page

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

== Description ==
One row of a section, by id, tenant-scoped and projected through the SAME declared field list as list - so an edit form can never receive a column the grid would not show.

{{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=get
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 key.
|}
== Example ==
<nowiki>https://host:port/newadm?func=get&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":{"row":{...declared fields...}}}</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 get - Revision history

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

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