OperatorAPI update

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

Description

Changes declared fields of one row, addressed by id. Immutable fields are refused server-side. A row belonging to another tenant is not matched, so it cannot be distinguished from one that does not exist.

ℹ A generic verb: it works over any section via the 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=update

Send your API key with every request (header X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).

Parameters

Parameter	Type	Required	Default	Meaning
section	string	Yes	—	The section key.
id	integer	Yes	—	The row to change.

Example

POST https://host:port/newadm?func=update&section=bonos&id=123  body {"price":2.0}

Response

Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape (n = number, s = string, ? = present only when set):

{
  "ok":true,
  "data":{
    "section":s,
    "id":n,
    "updated":true
  }
}

Errors

Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.

---

Back to OperatorAPI