OperatorAPI delete

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.

ℹ 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=delete

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 remove.
confirm_cascade	boolean	No	false	Proceed although dependent rows will be deleted too. (Only needed when a previous call reported a cascade count)

Example

POST https://host:port/newadm?func=delete&section=bonos&id=123

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,
    "deleted":true,
    "cascaded":n
  }
}

Errors

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

---

Back to OperatorAPI