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 ==
The SAME query as list, rendered as a delimited file. Every view parameter is identical - fields, order, dir, filterby, filter - so exporting "what I am looking at" is this call with the parameters the grid was already using, never a second code path that could disagree about what that was. Columns may be NARROWED with fields and never widened: a name that is not declared by the section is refused. A separator inside a value is quoted (RFC4180), so a value containing the delimiter cannot silently split into two columns as the legacy export does. Refuses rather than truncates above 50000 rows.

{{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=export
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>fields</code> || string || No || — || Comma-separated subset of the declared fields, in the order you want the columns. (Empty = every declared field. An undeclared name is refused BY NAME)
|-
| <code>sep</code> || string || No || <code>tab</code> || Field separator: tab, comma, semicolon, pipe, or one literal character. (The legacy default was TAB (export_separator). A quote or a newline is refused)
|-
| <code>decimal</code> || string || No || <code>.</code> || Decimal mark for numeric columns: "." or ",". (The legacy wrote "," (export_floatsig). Refused when it equals sep)
|-
| <code>header</code> || boolean || No || <code>true</code> || Write a header row of field names.
|-
| <code>order</code> || string || No || — || Sort field, from the declared set.
|-
| <code>dir</code> || string || No || <code>asc</code> || asc or desc.
|-
| <code>filterby</code> || string || No || — || Field to search, from the declared set.
|-
| <code>filter</code> || string || No || — || Literal substring, case-insensitive.
|}
== Example ==
<nowiki>https://host:port/newadm?func=export&section=bonos&fields=name,price&sep=semicolon&decimal=,&order=name</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape: <code>text/csv attachment - not a JSON envelope. Errors ARE JSON envelopes.</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 export - Revision history

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