Class UpdateRequestBuilder<EntityT>

Create Odata query to update an entity

Type parameters

EntityT: Entity

Type of the entity to be updated

Hierarchy

MethodRequestBuilderBase<EntityT, ODataUpdateRequestConfig<EntityT>>
- UpdateRequestBuilder

Implements

EntityIdentifiable<EntityT>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UpdateRequestBuilder(entityConstructor: Constructable<EntityT>, entity: EntityT): UpdateRequestBuilder

Overrides MethodRequestBuilderBase.constructor
- Defined in core/src/request-builder/update-request-builder.ts:20
Creates an instance of UpdateRequestBuilder.

Parameters
- entityConstructor: Constructable<EntityT>
  
  Constructor type of the entity to be updated
- entity: EntityT
  
  Entity to be updated
Returns UpdateRequestBuilder

Properties

entityConstructor

entityConstructor: Constructable<EntityT>

Constructor type of the entity to create a request for

Protected requestConfig

requestConfig: ODataUpdateRequestConfig<EntityT>

Request configuration to initialize with

Methods

build

build(destination: Destination | DestinationNameAndJwt): Promise<ODataRequest<EntityT, ODataUpdateRequestConfig<EntityT>>>

Inherited from MethodRequestBuilderBase.build
- Defined in core/src/request-builder/request-builder-base.ts:58
Parameters
- destination: Destination | DestinationNameAndJwt
Returns Promise<ODataRequest<EntityT, ODataUpdateRequestConfig<EntityT>>>

execute

execute(destination: Destination | DestinationNameAndJwt): Promise<EntityT>

- Defined in core/src/request-builder/update-request-builder.ts:38
Executes the query

Parameters
- destination: Destination | DestinationNameAndJwt
Returns Promise<EntityT>

A promise resolving to the entity once it was updated

Protected getKeyFieldNames

getKeyFieldNames(): string[]

Inherited from MethodRequestBuilderBase.getKeyFieldNames
- Defined in core/src/request-builder/request-builder-base.ts:63
Returns string[]

ignoredFields

ignoredFields(...fields: Array<Selectable<EntityT>>): this

- Defined in core/src/request-builder/update-request-builder.ts:67
Specifies entity fields to ignore by the update request.

Parameters
- Rest ...fields: Array<Selectable<EntityT>>
  
  Enumeration of the fields to be ignored
Returns this

The entity itself, to facilitate method chaining

requiredFields

requiredFields(...fields: Array<Selectable<EntityT>>): this

- Defined in core/src/request-builder/update-request-builder.ts:57
Specifies required entity keys for the update request.

Parameters
- Rest ...fields: Array<Selectable<EntityT>>
  
  Enumeration of the fields to be required
Returns this

The entity itself, to facilitate method chaining

url

url(destination: Destination | DestinationNameAndJwt): Promise<string>

Inherited from MethodRequestBuilderBase.url
- Defined in core/src/request-builder/request-builder-base.ts:32
Create the url based on configuration of the given builder

Parameters
- destination: Destination | DestinationNameAndJwt
Returns Promise<string>

Promise resolving to the url for the request

withCustomHeaders

withCustomHeaders(headers: MapType<string>): this

Inherited from MethodRequestBuilderBase.withCustomHeaders
- Defined in core/src/request-builder/request-builder-base.ts:42
Add custom headers to the request

Parameters
- headers: MapType<string>
  
  Key-value pairs denoting additional custom headers
Returns this

The request builder itself, to facilitate method chaining

withCustomServicePath

withCustomServicePath(servicePath: string): this

Inherited from MethodRequestBuilderBase.withCustomServicePath
- Defined in core/src/request-builder/request-builder-base.ts:53
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 this

The request builder itself, to facilitate method chaining