$setValue_Request method

@experimental Request $setValue_Request({ required String app, required String formId, required String fieldId, required ContentString<JsonObject> value, bool? oCSAPIRequest, })

Sets a declarative settings value.

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

Parameters:

• app ID of the app.
• formId ID of the form.
• fieldId ID of the field.
• value Value to be saved.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Value set successfully
• 500: Not logged in or not an admin user
• 400: Invalid arguments to save value

See:

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

Implementation

@_i2.experimental
_i3.Request $setValue_Request({
  required String app,
  required String formId,
  required String fieldId,
  required ContentString<JsonObject> value,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $app = _$jsonSerializers.serialize(app, specifiedType: const FullType(String));
  _parameters['app'] = $app;

  final $formId = _$jsonSerializers.serialize(formId, specifiedType: const FullType(String));
  _parameters['formId'] = $formId;

  final $fieldId = _$jsonSerializers.serialize(fieldId, specifiedType: const FullType(String));
  _parameters['fieldId'] = $fieldId;

  final $value =
      _$jsonSerializers.serialize(value, specifiedType: const FullType(ContentString, [FullType(JsonObject)]));
  _parameters['value'] = $value;

  final _path = _i4.UriTemplate('/ocs/v2.php/settings/api/declarative/value{?app*,formId*,fieldId*,value*}')
      .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _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 _i5.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}