$getNote_Request method
Returns a DynamiteRequest
backing the getNote operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
exclude
Defaults to""
.ifNoneMatch
Status codes:
- 200
See:
- getNote for a method executing this request and parsing the response.
- $getNote_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $getNote_Request({
required int id,
String? exclude,
String? ifNoneMatch,
}) {
final _parameters = <String, Object?>{};
final $id = _$jsonSerializers.serialize(id, specifiedType: const FullType(int));
_parameters['id'] = $id;
var $exclude = _$jsonSerializers.serialize(exclude, specifiedType: const FullType(String));
$exclude ??= '';
_parameters['exclude'] = $exclude;
final _path = _i4.UriTemplate('/index.php/apps/notes/api/v1/notes/{id}{?exclude*}').expand(_parameters);
final _uri = Uri.parse('$baseURL$_path');
final _request = _i3.Request('get', _uri);
_request.headers['Accept'] = 'application/json';
// coverage:ignore-start
final authentication = authentications?.firstWhereOrNull(
(auth) => switch (auth) {
_i1.DynamiteHttpBasicAuthentication() => true,
_ => false,
},
);
if (authentication != null) {
_request.headers.addAll(
authentication.headers,
);
} else {
throw Exception('Missing authentication for basic_auth');
}
// coverage:ignore-end
final $ifNoneMatch = _$jsonSerializers.serialize(ifNoneMatch, specifiedType: const FullType(String));
if ($ifNoneMatch != null) {
_request.headers['If-None-Match'] = const _i5.HeaderEncoder().convert($ifNoneMatch);
}
return _request;
}