RequestInput

Request input, normalizing a Kuzzle API call in JSON format.

This is the class used to build the input property of any Request object.

Technical information: github repository


Constructor

Copied to clipboard!
new RequestInput(data);

Arguments Type Description
data
object
API request, in JSON format

data

The data object can contain the following properties:

Properties Type Description
_id
string
Resource unique identifier
action
string
Invoked API controller's action
body
object
Request specific data (document content, search queries, ...)
collection
string
Collection
controller
string
Invoked API controller
index
string
Index
jwt
string
Authentication token
volatile
object
Request volatile data
...
*
Unrecognized properties are considered request specific, and stored in the args object property

Properties

Properties Type Description
action
string
Invoked API controller's action
args
object
Request specific arguments
body
object
Request specific data
controller
string
Invoked API controller
jwt
string
Authentication token
resource
object
Stored resource target
volatile
object
Request volatile data

resource

The resource property contains resources information:

Properties Type Description
_id
string
Resource unique identifier
collection
string
Collection
index
string
Index