BODY_PARAMETER_NAME

Specify which parameter receives the raw request body.

Keywords

body_parameter_name, body_param_name

Syntax

body_parameter_name <param-name>

Examples

Custom Body Parameter

create function process_payload(_metadata json, _payload text)
returns json
language sql
as $$...$$;

comment on function process_payload(json, text) is
'HTTP POST
body_parameter_name _payload';

JSON Body Parameter

create function handle_webhook(_body json)
returns void
language sql
as $$...$$;

comment on function handle_webhook(json) is
'HTTP POST
body_parameter_name _body';

Behavior

• Directs the raw request body to the specified parameter
• Useful when you need access to the complete body content
• Parameter type should match expected content (text, json, bytea)

Related

• NpgsqlRest Options configuration - Configure default body parameter
• Comment Annotations Guide - How annotations work
• Configuration Guide - How configuration works

Related Annotations

• REQUEST_PARAM_TYPE - Control parameter source