$addResource_Request method
- @experimental
Add a resource to a collection.
Returns a DynamiteRequest
backing the addResource operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
resourceType
Name of the resource.resourceId
ID of the resource.collectionId
ID of the collection.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Collection returned
- 404: Collection not found or resource inaccessible
- 500
See:
- addResource for a method executing this request and parsing the response.
- $addResource_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $addResource_Request({
required String resourceType,
required String resourceId,
required int collectionId,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
final $resourceType = _$jsonSerializers.serialize(resourceType, specifiedType: const FullType(String));
_parameters['resourceType'] = $resourceType;
final $resourceId = _$jsonSerializers.serialize(resourceId, specifiedType: const FullType(String));
_parameters['resourceId'] = $resourceId;
final $collectionId = _$jsonSerializers.serialize(collectionId, specifiedType: const FullType(int));
_parameters['collectionId'] = $collectionId;
final _path =
_i5.UriTemplate('/ocs/v2.php/collaboration/resources/collections/{collectionId}{?resourceType*,resourceId*}')
.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 _i4.HeaderEncoder().convert($oCSAPIRequest);
return _request;
}