GenericResponseComplete

com.apama.cumulocity
Event GenericResponseComplete

Response from Cumulocity after the last GenericResponse event for a given request.

It is very important to report any error (error=true) responses, for example by logging the response at ERROR (or WARN) level. If failed responses are not logged it may be very difficult to debug problems caused by unexpected errors.

These events are sent to the GenericResponse.SUBSCRIBE_CHANNEL channel.

Since:: 10.5.0.0

Constant summary
`string`	`CHANNEL := "cumulocity.generic.response"` The channel to which `Generic` responses are sent from the transport. Deprecated: [This channel constant has been deprecated. Use GenericResponse.SUBSCRIBE_CHANNEL instead.]

Field summary
`integer`	`reqId` Request identifier from the original GenericRequest.
`boolean`	`error` True if an error was received during this GenericRequest.
`integer`	`statusCode` Status code from the final response.
`string`	`details` Response details that weren't sent as GenericResponse events.

Constant detail

CHANNEL

string CHANNEL := "cumulocity.generic.response"

Deprecated:: [This channel constant has been deprecated. Use GenericResponse.SUBSCRIBE_CHANNEL instead.]

The channel to which Generic responses are sent from the transport.

Field detail

details

string details

Response details that weren't sent as GenericResponse events.

Typically this will be the error message parsed from the error event. For other responses which weren't success JSON payloads (non-success, non-error content type, or success-non-JSON) it'll be whatever payload was returned.

error

boolean error

True if an error was received during this GenericRequest.

reqId

integer reqId

Request identifier from the original GenericRequest.

statusCode

integer statusCode