type
fields
uri |
URI of endpoint such as "http://host/api/myProj/". |
---|
methods
about |
Call "about" operation to query server summary info. |
---|---|
call |
Call the given REST operation with its request grid and return the response grid. |
close |
Close the session by sending the |
commit |
Commit a set of diffs. |
eval |
Evaluate an Axon expression and return results as Grid. |
open |
Open with URI of project such as "http://host/api/myProj/". |
read |
Call "read" operation to read a record that matches the given filter. |
readAll |
Call "read" operation to read a record all recs which match the given filter. |
readById |
Call "read" operation to read a record by its identifier. |
readByIds |
Call "read" operation to read a list of records by their identifiers. |
toStr |
Return uri.toStr |
Slot Details
about
call
Grid call(Str op, Grid? req := null, Bool checked := true)
Call the given REST operation with its request grid and return the response grid. If req is null, then an empty grid used for request. If the checked flag is true and server returns an error grid, then raise CallErr
, otherwise return the grid itself.
close
Void close()
Close the session by sending the close
op.
commit
Commit a set of diffs. The req parameter must be a grid with a "commit" tag in the grid.meta. The rows are the items to commit. Return result as Grid or or raise CallErr
if server returns error grid.
Also see HTTP API
.
Examples:
// add new record tags := ["site":Marker.val, "dis":"Example Site"]) toCommit := Etc.makeDictGrid(["commit":"add"], tags) client.commit(toCommit) // update dis tag changes := ["id": orig->id, "mod":orig->mod, "dis": "New dis"] toCommit := Etc.makeDictGrid(["commit":"update"], changes) client.commit(toCommit)
eval
open
read
Dict? read(Str filter, Bool checked := true)
Call "read" operation to read a record that matches the given filter. If there is more than one record, then it is undefined which one is returned. If there are no matches then return null or raise UnknownRecException based on checked flag. Raise CallErr
if server returns error grid. Also see HTTP API.
readAll
readById
readByIds
Grid readByIds(Obj[] ids, Bool checked := true)
Call "read" operation to read a list of records by their identifiers. Return a grid where each row of the grid maps to the respective id list (indexes line up). If checked is true and any one of the ids cannot be resolved then raise UnknownRecErr for first id not resolved. If checked is false, then each id not found has a row where every cell is null. Raise CallErr
if server returns error grid. Also see HTTP API.
toStr
virtual override Str toStr()
Return uri.toStr
uri
const Uri uri
URI of endpoint such as "http://host/api/myProj/". This URI always ends in a trailing slash.