$show method
Future<DynamiteResponse<ConfigapiShowResponseApplicationJson, void> >
$show({
- required String configID,
- ConfigapiShowShowPassword? showPassword,
- bool? oCSAPIRequest,
Get a configuration.
Output can look like this: . This endpoint requires admin access.
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:
configID
ID of the config.showPassword
Whether to show the password. Defaults to0
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Config returned
- 404: Config not found
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<ConfigapiShowResponseApplicationJson, void>> $show({
required String configID,
ConfigapiShowShowPassword? showPassword,
bool? oCSAPIRequest,
}) async {
final _request = $$show_Request(
configID: configID,
showPassword: showPassword,
oCSAPIRequest: oCSAPIRequest,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $$show_Serializer();
return _i1.ResponseConverter<ConfigapiShowResponseApplicationJson, void>(_serializer).convert(_response);
}