index method

Future<DynamiteResponse<ApiColumnsIndexResponseApplicationJson, void>> index({ 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 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:

• 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_Request for the request send by this method.
• $index_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<ApiColumnsIndexResponseApplicationJson, void>> index({
  required ApiColumnsIndexNodeType nodeType,
  required int nodeId,
  bool? oCSAPIRequest,
}) async {
  final _request = $index_Request(
    nodeType: nodeType,
    nodeId: nodeId,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $index_Serializer();
  return _i1.ResponseConverter<ApiColumnsIndexResponseApplicationJson, void>(_serializer).convert(_response);
}