Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetByKeyRequestBuilderV4<EntityT>

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

Index

Constructors

constructor

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT>

Constructor of the entity to create the request for

Readonly dataAccessor

dataAccessor: ResponseDataAccessor

Readonly entityDeserializer

entityDeserializer: EntityDeserializer

Entity deserializer

requestConfig

requestConfig: ODataGetByKeyRequestConfig<EntityT>

Request configuration to initialize with

Methods

build

execute

expand

relativeUrl

  • relativeUrl(): string

select

url

withCustomHeaders

  • withCustomHeaders(headers: Record<string, string>): this

withCustomQueryParameters

  • withCustomQueryParameters(queryParameters: Record<string, string>): this

withCustomServicePath

  • withCustomServicePath(servicePath: string): this