$getColumn_Request method

@experimental Request $getColumn_Request({ required int columnId, })

Returns a column object.

Returns a DynamiteRequest backing the getColumn operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• columnId Wanted Column ID.

Status codes:

• 200: Column returned
• 403: No permissions
• 500
• 404: Not found

See:

• getColumn for a method executing this request and parsing the response.
• $getColumn_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $getColumn_Request({required int columnId}) {
  final _parameters = <String, Object?>{};
  final __columnId = _$jsonSerializers.serialize(columnId, specifiedType: const FullType(int));
  _parameters['columnId'] = __columnId;

  final _path = _i5.UriTemplate('/index.php/apps/tables/api/1/columns/{columnId}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i4.IterableExtension(_rootClient.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
  return _request;
}