Response #
Response is a serializable class representing a raw Kuzzle response.
Properties #
| Property | Type | Description |
|---|---|---|
action | String | Executed Kuzzle API controller's action |
collection | String | Impacted collection |
controller | String | Executed Kuzzle API controller |
error | ErrorResponse | Error object (null if the request finished successfully) |
headers | Map<String, Object> | Headers returned in the response |
index | String | Impacted index |
protocol | String | Network protocol at the origin of the real-time notification |
requestId | String | Request unique identifier |
result | Object | Response payload (depends on the executed API action) |
room | String | Room identifier (realtime only) |
scope | String | Document scope ("in" or "out", realtime only) |
state | String | Document state (realtime only) |
status | int | Response status, following HTTP status codes |
timestamp | Long | Notification timestamp (UTC) |
volatile | Map<String, Object> | Volatile data |
Edit this page on Github(opens new window)