$index_Request method

@experimental Request $index_Request({ required ApiColumnsIndexNodeType nodeType, required int nodeId, bool? oCSAPIRequest, })

api v2 Get all columns for a table or a view.

Return an empty array if no columns were found.

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

Parameters:

• nodeType Node type.
• nodeId Node ID.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

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

See:

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

Implementation

@_i2.experimental
_i3.Request $index_Request({
  required ApiColumnsIndexNodeType nodeType,
  required int nodeId,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final __nodeType = _$jsonSerializers.serialize(nodeType, specifiedType: const FullType(ApiColumnsIndexNodeType));
  _parameters['nodeType'] = __nodeType;

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

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/tables/api/2/columns/{nodeType}/{nodeId}').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.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  __oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i6.HeaderEncoder().convert(__oCSAPIRequest);

  return _request;
}