create method
api v2
Add a node (table or view) to user favorites.
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
any Application::NODE_TYPE_* constant.nodeId
identifier of the node.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Tables returned
- 403: No permissions
- 500
- 404: Not found
See:
- $create_Request for the request send by this method.
- $create_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<ApiFavoriteCreateResponseApplicationJson, void>> create({
required int nodeType,
required int nodeId,
bool? oCSAPIRequest,
}) async {
final _request = $create_Request(
nodeType: nodeType,
nodeId: nodeId,
oCSAPIRequest: oCSAPIRequest,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $create_Serializer();
return _i1.ResponseConverter<ApiFavoriteCreateResponseApplicationJson, void>(_serializer).convert(_response);
}