Abstract
Type of the entity to be updated
Creates an instance of UpdateRequestBuilder.
Entity API for building and executing the request.
Entity to be updated.
URI conversion functions.
Entity serializer.
Extractor for ETag from payload.
Manipulator for the payload.
Readonly
_deDummy property to include also the deserializer type in the strucutre of the entity type.
Readonly
_entityDummy property whose type makes structurally identical entities distiguishable in TypeScript.
Readonly
_entityReadonly
entityReadonly
extractODataReadonly
oReadonly
payloadAdd custom headers to the request. Existing headers will be overwritten.
The request builder itself, to facilitate method chaining.
Key-value pairs denoting additional custom headers.
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
The request builder itself, to facilitate method chaining.
Key-value pairs denoting additional custom query parameters to be set in the request.
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.
The request builder itself, to facilitate method chaining.
Key-value pairs denoting additional custom request configuration options to be set in the request.
Append the given path to the URL.
This can be used for querying navigation properties of an entity.
To execute a request with an appended path use executeRaw
to avoid errors during deserialization. When using this, the execute
method is omitted from the return type.
The request builder itself without "execute" function, to facilitate method chaining.
Rest
...path: string[]Path to be appended.
Protected
buildProtected
executeExecutes the query.
A promise resolving to the entity once it was updated.
Request object to be executed.
Protected
executeGets identifier for the batch request.
Batch request identifier.
Protected
getInstructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.
The request itself to ease chaining while executing the request.
Protected
isExplicitly configure 'PUT' as the method of the update request. By default, only the properties that have changed compared to the last known remote state are sent using 'PATCH', while with 'PUT', the whole entity is sent.
The entity itself, to facilitate method chaining.
Replace the default service path with the given custom path.
In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME>
and can be overwritten here.
The request builder itself, to facilitate method chaining.
Path to override the default with.
Sets entity fields to ignore by the update request.
The entity itself, to facilitate method chaining.
Rest
...fields: Selectable<EntityT, DeSerializersT>[]Enumeration of the fields to be ignored.
Sets required entity keys for the update request.
The entity itself, to facilitate method chaining.
Rest
...fields: Selectable<EntityT, DeSerializersT>[]Enumeration of the fields to be required.
Sets ETag version identifier of the entity to update.
The request itself to ease chaining while executing the request.
Custom ETag version identifier to be sent in the header of the request.
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
The request builder itself, to facilitate method chaining.
Set timeout for requests towards the target system given in the destination.
The request builder itself, to facilitate method chaining.
Since v2.13.0. The timeout configuration is replaced by the more general middleware approach in version 3.0 of the SAP Cloud SDK.
Value is in milliseconds and default value is 10000 (10 seconds).
Create the URL based on configuration of the given builder.
Promise resolving to the URL for the request.
Destination or DestinationFetchOptions to execute the request against.
Copyright Ⓒ 2023 SAP SE or an SAP affiliate company. All rights reserved.
Abstract class to create OData query to update an entity containing methods shared for OData v2 and v4.