$show method
api v2
Get information about the requests context.
Returns a Future containing a DynamiteResponse
with the status code, deserialized body and headers.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
contextId
ID of the context.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: returning the full context information
- 500
- 404: context not found or not available anymore
See:
- $$show_Request for the request send by this method.
- $$show_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<ContextShowResponseApplicationJson, void>> $show({
required int contextId,
bool? oCSAPIRequest,
}) async {
final _request = $$show_Request(
contextId: contextId,
oCSAPIRequest: oCSAPIRequest,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $$show_Serializer();
return _i1.ResponseConverter<ContextShowResponseApplicationJson, void>(_serializer).convert(_response);
}