Options
All
  • Public
  • Public/Protected
  • All
Menu

Create OData query to update an entity.

Type parameters

  • EntityT: Entity

    Type of the entity to be updated

Hierarchy

Implements

  • EntityIdentifiable<EntityT>

Index

Constructors

  • new UpdateRequestBuilder<EntityT>(_entityConstructor: Constructable<EntityT, unknown>, _entity: EntityT): UpdateRequestBuilder<EntityT>
  • Creates an instance of UpdateRequestBuilder.

    Type parameters

    Parameters

    • _entityConstructor: Constructable<EntityT, unknown>

      Constructor type of the entity to be updated

    • _entity: EntityT

      Entity to be updated

    Returns UpdateRequestBuilder<EntityT>

Properties

_entity: EntityT
_entityConstructor: Constructable<EntityT, unknown>
entitySerializer: EntitySerializer<any, any>
extractODataEtag: (json: Record<string, any>) => undefined | string

Type declaration

    • (json: Record<string, any>): undefined | string
    • Parameters

      • json: Record<string, any>

      Returns undefined | string

oDataUri: ODataUri
payloadManipulator: (body: Record<string, any>) => Record<string, any>

Type declaration

    • (body: Record<string, any>): Record<string, any>
    • Parameters

      • body: Record<string, any>

      Returns Record<string, any>

requestConfig: ODataUpdateRequestConfig<EntityT>

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 UpdateRequestBuilder<EntityT>

    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 UpdateRequestBuilder<EntityT>

    The request builder itself, to facilitate method chaining

  • addCustomRequestConfiguration(requestConfiguration: Record<string, string>): UpdateRequestBuilder<EntityT>
  • 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: Record<string, string>

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

    Returns UpdateRequestBuilder<EntityT>

    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

    • Rest ...path: string[]

      Path to be appended.

    Returns Omit<UpdateRequestBuilder<EntityT>, "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

  • Execute request and return an HttpResponse. The request is only executed if some properties of the entity are modified.

    Parameters

    Returns Promise<undefined | HttpResponse>

    A promise resolving to an HttpResponse when the request is executed or undefined otherwise.

  • getPayload(): Record<string, any>
  • 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 UpdateRequestBuilder<EntityT>

    The request itself to ease chaining while executing the request.

  • isEmptyObject(obj: any): boolean
  • deprecated

    Since v1.29.0. This method should never be called, it has severe side effects. Builds the payload and the entity keys of the query.

    Returns UpdateRequestBuilder<EntityT>

    the builder itself

  • relativeUrl(): string
  • 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 UpdateRequestBuilder<EntityT>

    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.

    Parameters

    • servicePath: string

      Path to override the default with

    Returns UpdateRequestBuilder<EntityT>

    The request builder itself, to facilitate method chaining

  • 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 UpdateRequestBuilder<EntityT>

    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 UpdateRequestBuilder<EntityT>

    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

  • deprecated

    Since version 1.34.0 Use addCustomHeaders instead. Add custom headers to the request.

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns UpdateRequestBuilder<EntityT>

    The request builder itself, to facilitate method chaining.

  • deprecated

    Since version 1.34.0 Use addCustomQueryParameters instead. Add custom query parameters to the request.

    Parameters

    • queryParameters: Record<string, string>

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

    Returns UpdateRequestBuilder<EntityT>

    The request builder itself, to facilitate method chaining.

  • deprecated

    Since version 1.34.0 Use setCustomServicePath instead. 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.

    Parameters

    • servicePath: string

      Path to override the default with.

    Returns UpdateRequestBuilder<EntityT>

    The request builder itself, to facilitate method chaining.

  • deprecated

    Since version 1.34.0 Use setVersionIdentifier instead. Specifies a custom 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 UpdateRequestBuilder<EntityT>

    The request itself to ease chaining while executing the request.

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