$setProgress_Request method

@experimental Request $setProgress_Request({ required int taskId, required TaskProcessingApiSetProgressRequestApplicationJson $body, bool? oCSAPIRequest, })

Sets the task progress.

This endpoint requires admin access.

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

Parameters:

• taskId The id of the task.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Progress updated successfully
• 500
• 404: Task not found

See:

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

Implementation

@_i2.experimental
_i3.Request $setProgress_Request({
  required int taskId,
  required TaskProcessingApiSetProgressRequestApplicationJson $body,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final __taskId = _$jsonSerializers.serialize(taskId, specifiedType: const FullType(int));
  _parameters['taskId'] = __taskId;

  final _path = _i6.UriTemplate('/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/progress').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 = _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 _i5.HeaderEncoder().convert(__oCSAPIRequest);

  _request.headers['Content-Type'] = 'application/json';
  _request.body = json.encode(
    _$jsonSerializers.serialize(
      $body,
      specifiedType: const FullType(TaskProcessingApiSetProgressRequestApplicationJson),
    ),
  );
  return _request;
}