Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

Hierarchy

Index

Constructors

constructor

  • new UpdateRequestBuilderV4<EntityT>(_entityConstructor: Constructable<EntityT, unknown>, _entity: EntityT): UpdateRequestBuilderV4<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 UpdateRequestBuilderV4<EntityT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Readonly entitySerializer

entitySerializer: EntitySerializer<any, any>

Readonly extractODataEtag

extractODataEtag: (json: Record<string, any>) => undefined | string

Type declaration

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

      • json: Record<string, any>

      Returns undefined | string

Readonly oDataUri

oDataUri: ODataUri

Readonly payloadManipulator

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

requestConfig: ODataUpdateRequestConfig<EntityT>

Accessors

entity

  • get entity(): EntityT
  • Returns EntityT

Methods

addCustomHeaders

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

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns UpdateRequestBuilderV4<EntityT>

    The request builder itself, to facilitate method chaining.

addCustomQueryParameters

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

    The request builder itself, to facilitate method chaining

addCustomRequestConfiguration

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

    The request builder itself, to facilitate method chaining.

appendPath

  • appendPath(...path: string[]): Pick<UpdateRequestBuilderV4<EntityT>, "_entityConstructor" | "_entity" | "entity" | "prepare" | "executeRaw" | "requestConfig" | "url" | "relativeUrl" | "withCustomHeaders" | "addCustomHeaders" | "withCustomQueryParameters" | "addCustomQueryParameters" | "withCustomServicePath" | "setCustomServicePath" | "addCustomRequestConfiguration" | "appendPath" | "skipCsrfTokenFetching" | "build" | "setVersionIdentifier" | "ignoreVersionIdentifier" | "oDataUri" | "entitySerializer" | "extractODataEtag" | "payloadManipulator" | "replaceWholeEntityWithPut" | "requiredFields" | "setRequiredFields" | "ignoredFields" | "setIgnoredFields" | "withCustomVersionIdentifier">
  • 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 Pick<UpdateRequestBuilderV4<EntityT>, "_entityConstructor" | "_entity" | "entity" | "prepare" | "executeRaw" | "requestConfig" | "url" | "relativeUrl" | "withCustomHeaders" | "addCustomHeaders" | "withCustomQueryParameters" | "addCustomQueryParameters" | "withCustomServicePath" | "setCustomServicePath" | "addCustomRequestConfiguration" | "appendPath" | "skipCsrfTokenFetching" | "build" | "setVersionIdentifier" | "ignoreVersionIdentifier" | "oDataUri" | "entitySerializer" | "extractODataEtag" | "payloadManipulator" | "replaceWholeEntityWithPut" | "requiredFields" | "setRequiredFields" | "ignoredFields" | "setIgnoredFields" | "withCustomVersionIdentifier">

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

build

execute

executeRaw

Protected executeRequest

Protected executeRequestRaw

Protected getPayload

  • getPayload(): Record<string, any>
  • Returns Record<string, any>

ignoreVersionIdentifier

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

    Returns UpdateRequestBuilderV4<EntityT>

    this The request itself to ease chaining while executing the request

ignoredFields

Protected isEmptyObject

  • isEmptyObject(obj: any): boolean
  • Parameters

    • obj: any

    Returns boolean

prepare

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

    the builder itself

relativeUrl

  • relativeUrl(): string
  • Create the relative url based on configuration of the given builder.

    Returns string

    The relative url for the request

replaceWholeEntityWithPut

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

    The entity itself, to facilitate method chaining

requiredFields

setCustomServicePath

  • Replace the default service path with the given custom path. In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/' and can be overwritten here.

    Parameters

    • servicePath: string

      Path to override the default with

    Returns UpdateRequestBuilderV4<EntityT>

    The request builder itself, to facilitate method chaining

setIgnoredFields

setRequiredFields

setVersionIdentifier

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

    The request itself to ease chaining while executing the request

skipCsrfTokenFetching

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

    Returns UpdateRequestBuilderV4<EntityT>

    The request builder itself, to facilitate method chaining.

url

withCustomHeaders

  • Add custom headers to the request.

    deprecated

    Since version 1.34.0 Use addCustomHeaders instead.

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers

    Returns UpdateRequestBuilderV4<EntityT>

    The request builder itself, to facilitate method chaining

withCustomQueryParameters

  • Add custom query parameters to the request.

    deprecated

    Since version 1.34.0 Use addCustomQueryParameters instead.

    Parameters

    • queryParameters: Record<string, string>

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

    Returns UpdateRequestBuilderV4<EntityT>

    The request builder itself, to facilitate method chaining

withCustomServicePath

  • Replace the default service path with the given custom path. In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/' and can be overwritten here.

    deprecated

    Since version 1.34.0 Use setCustomServicePath instead.

    Parameters

    • servicePath: string

      Path to override the default with

    Returns UpdateRequestBuilderV4<EntityT>

    The request builder itself, to facilitate method chaining

withCustomVersionIdentifier

  • Specifies a custom ETag version identifier of the entity to update.

    deprecated

    Since version 1.34.0 Use setVersionIdentifier instead.

    Parameters

    • etag: string

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

    Returns UpdateRequestBuilderV4<EntityT>

    The request itself to ease chaining while executing the request