OperatorAPI sections
newadmapi (Operator API) function. Available to: Operator, SuperRoot.
Description
Every section this service serves, with what each offers and what THIS caller may do with it. Read-only. Paired with func=options, which describes one section in full: ask this what exists, then ask that how to talk to it - a client that reads both hardcodes neither the list of sections nor the shape of any one of them.
section parameter. Discover sections with OperatorAPI sections and a section's fields/capabilities with OperatorAPI options.Call
GET|POST https://YOUR_HOST:9089/newadm?func=sections
Send your API key with every request (header X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).
Parameters
None beyond the API key and func=sections.
Example
https://host:port/newadm?func=sections
Response
Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape: {"ok":true,"data":{"sections":[{"section":s,"relation":s,"scope":s,"default_order":s,"fields":[s],"writable":b,"complete":b,"can":{"insert":b,"update":b,"delete":b,"import":b},"options":s}],"served":n,"complete":n,"verbs":s}}.
Errors
Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.
Back to OperatorAPI