$indexTableColumns_Request method

@experimental Request $indexTableColumns_Request({ required int tableId, int? viewId, })

Get all columns for a table or a underlying view Return an empty array if no columns were found.

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

Parameters:

• tableId Table ID.
• viewId View ID.

Status codes:

• 200: View deleted
• 403: No permissions
• 500
• 404: Not found

See:

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

Implementation

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

  final __viewId = _$jsonSerializers.serialize(viewId, specifiedType: const FullType(int));
  _parameters['viewId'] = __viewId;

  final _path =
      _i5.UriTemplate('/index.php/apps/tables/api/1/tables/{tableId}/columns{?viewId*}').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;
}