SAP Cloud SDK for JavaScript - v4.1.1
    Preparing search index...

    Class UpdateRequestBuilder<EntityT, DeSerializersT>

    Create OData query to update an entity.

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    _deSerializers: DeSerializersT

    Dummy property to also include the deserializer type in the structure of the entity type.

    _entity: EntityT

    Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

    entitySerializer: EntitySerializer
    extractODataEtag: (json: Record<string, any>) => undefined | string
    payloadManipulator: (body: Record<string, any>) => Record<string, any>

    Accessors

    • get entity(): EntityT

      Returns EntityT

    Methods

    • Add custom headers to the request. Existing headers will be overwritten.

      Parameters

      • headers: Record<string, string>

        Key-value pairs denoting additional custom headers.

      Returns this

      The request builder itself, to facilitate method chaining.

    • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

      Parameters

      • queryParameters: Record<string, string>

        Key-value pairs denoting additional custom query parameters to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

    • 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.

      Parameters

      • requestConfiguration: CustomRequestConfig

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

    • 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.

      Parameters

      • ...path: string[]

        Path to be appended.

      Returns Omit<this, "execute">

      The request builder itself without "execute" function, to facilitate method chaining.

    • Executes the query.

      Parameters

      Returns Promise<EntityT>

      A promise resolving to the entity once it was updated.

    • Returns Record<string, any>

    • Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.

      Returns this

      The request itself to ease chaining while executing the request.

    • Parameters

      • obj: any

      Returns boolean

    • Set middleware for requests towards the target system given in the destination.

      Parameters

      Returns this

      The request builder itself, to facilitate method chaining.

    • Set middleware for requests towards the target system given in the destination.

      Parameters

      • ...middlewares: HttpMiddleware[]

        Middlewares to be applied to the executeHttpRequest().

      Returns this

      The request builder itself, to facilitate method chaining.

    • Create the relative URL based on configuration of the given builder.

      Returns string

      The relative URL for the request.

    • Explicitly 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.

      Returns this

      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 basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

    • Sets user-defined identifier for the batch reference.

      Parameters

      • id: string

        User-defined batch request identifier.

      Returns void

    • Sets ETag version identifier of the entity to update.

      Parameters

      • etag: string

        Custom ETag version identifier to be sent in the header of the request.

      Returns this

      The request itself to ease chaining while executing the request.

    • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

      Returns this

      The request builder itself, to facilitate method chaining.

    • Create the URL based on configuration of the given builder.

      Parameters

      Returns Promise<string>

      Promise resolving to the URL for the request.

      Copyright Ⓒ 2025 SAP SE or an SAP affiliate company. All rights reserved.