Options
All
  • Public
  • Public/Protected
  • All
Menu

Create an OData request to get a single entity based on its key properties. The properties available in the response can be restricted by creating a selection, where no selection is equal to selecting all fields of the entity. Navigational properties need to expanded explicitly by GetAllRequestBuilderV4.expand. where no selection is equal to selecting all fields.

Type parameters

  • EntityT: EntityV4

    Type of the entity to be requested

Hierarchy

Implements

  • EntityIdentifiable<EntityT>

Index

Constructors

constructor

  • Creates an instance of GetByKeyRequestBuilder.

    Type parameters

    Parameters

    • _entityConstructor: Constructable<EntityT, unknown>

      Constructor of the entity to create the request for

    • keys: Record<string, FieldType>

      Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value

    Returns GetByKeyRequestBuilderV4<EntityT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Readonly dataAccessor

dataAccessor: ResponseDataAccessor

Readonly entityDeserializer

entityDeserializer: EntityDeserializer<any>

requestConfig

requestConfig: ODataGetByKeyRequestConfig<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 GetByKeyRequestBuilderV4<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 GetByKeyRequestBuilderV4<EntityT>

    The request builder itself, to facilitate method chaining

addCustomRequestConfiguration

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

    The request builder itself, to facilitate method chaining.

appendPath

  • 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<GetByKeyRequestBuilderV4<EntityT>, "execute">

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

build

execute

executeRaw

expand

  • Parameters

    Returns GetByKeyRequestBuilderV4<EntityT>

  • Parameters

    Returns GetByKeyRequestBuilderV4<EntityT>

relativeUrl

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

    Returns string

    The relative URL for the request

select

setCustomServicePath

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

    The request builder itself, to facilitate method chaining

skipCsrfTokenFetching

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

    Returns GetByKeyRequestBuilderV4<EntityT>

    The request builder itself, to facilitate method chaining.

url

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

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request

withCustomHeaders

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

    The request builder itself, to facilitate method chaining.

withCustomQueryParameters

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

    The request builder itself, to facilitate method chaining.

withCustomServicePath

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

    The request builder itself, to facilitate method chaining.

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