Skip to content
This page View Markdown Open in ChatGPT Open in Claude

The code in every language

Each example is the inside of main, written in every language API Maker runs : pick yours in the tabs, and every page shows it from then on. The types a call takes (GetAll, DeepItem…) are those of am : from am import GetAll in Python, use am::GetAll; in Rust, import am.GetAll; in Java and Kotlin ; PHP and C# have them without an import, Go names them am.GetAll.

The request : g.req

Custom APIs, hooks, events and schedulers read the request through g.req. Who calls is in g.req.auth : see Who calls : g.req.auth.

Body

To get the value of request body, use g.req.body.

const body = g.req.body;
body = g.req.body
$body = $g->req->body;
var body = g.Req.Body;
body := g.Req.Body()
let body = g.req.body();
JsonObject body = g.req.getBody();
val body = g.req.body

Headers

To get the value of requested headers, use g.req.headers.

const headers = g.req.headers;
headers = g.req.headers
$headers = $g->req->headers;
var headers = g.Req.Headers;
headers := g.Req.Headers()
let headers = g.req.headers();
JsonObject headers = g.req.getHeaders();
val headers = g.req.headers

The tenant header of a request of a tenant of a multi-tenant instance. g.req.params.tenantUsername holds the tenant too, also when the request named it in the path (crm::acme).

const tenantUsername = g.req.headers['x-am-tenant-username']; // 'acme'
tenant_username = g.req.headers.get('x-am-tenant-username')  # 'acme'
$tenantUsername = $g->req->headers['x-am-tenant-username']; // 'acme'
var tenantUsername = g.Req.Headers.GetString("x-am-tenant-username"); // "acme"
tenantUsername := g.Req.Headers().String("x-am-tenant-username") // "acme"
let tenant_username = g.req.headers()["x-am-tenant-username"].as_str(); // Some("acme")
String tenantUsername = g.req.getHeaders().getString("x-am-tenant-username"); // "acme"
val tenantUsername = g.req.headers.getString("x-am-tenant-username") // "acme"

Params

To get the value of requested params, use g.req.params.

const params = g.req.params;
params = g.req.params
$params = $g->req->params;
var parameters = g.Req.Params;
params := g.Req.Params()
let params = g.req.params();
JsonObject params = g.req.getParams();
val params = g.req.params

The tenant of the request, for a multi-tenant instance: named with the x-am-tenant-username header, or in the path of an API of the instance (crm::acme).

const tenantUsername = g.req.params.tenantUsername; // 'acme', undefined without a tenant
tenant_username = g.req.params.tenantUsername  # 'acme', None without a tenant
$tenantUsername = $g->req->params->tenantUsername; // 'acme', null without a tenant
var tenantUsername = g.Req.Params.GetString("tenantUsername"); // "acme", null without a tenant
tenantUsername := g.Req.Params().String("tenantUsername") // "acme", "" without a tenant
let tenant_username = g.req.params()["tenantUsername"].as_str(); // Some("acme"), None without a tenant
String tenantUsername = g.req.getParams().getString("tenantUsername"); // "acme", null without a tenant
val tenantUsername = g.req.params.getString("tenantUsername") // "acme", null without a tenant

Query params

To get the value of requested query params, use g.req.query.

const query = g.req.query;
query = g.req.query
$query = $g->req->query;
var query = g.Req.Query;
query := g.Req.Query()
let query = g.req.query();
JsonObject query = g.req.getQuery();
val query = g.req.query

Event data

To get the value of requested body data of the event, use g.req.eventData.

const eventData = g.req.eventData;
event_data = g.req.event_data
$eventData = $g->req->eventData;
var eventData = g.Req.EventData;
eventData := g.Req.EventData()
let event_data = g.req.event_data();
Object eventData = g.req.getEventData();
val eventData = g.req.eventData