Representation of a batch change set, which holds a collection of write operations.
-Representation of a batch change set, which holds a collection of write operations.
+Create an instance of BatchChangeSet.
+Create an instance of BatchChangeSet.
Requests to combine to one change set.
-Optional
boundary: stringRequest boundary for separation of sub requests. Defaults to an auto generated value.
+Optional
boundary: stringRequest boundary for separation of sub requests. Defaults to an auto generated value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Readonly
boundaryReadonly
requestsRepresentation of a filter function, that returns a value of type boolean.
-Representation of a filter function, that returns a value of type boolean.
+Creates an instance of BooleanFilterFunction.
+Creates an instance of BooleanFilterFunction.
Name of the function that returns a boolean value.
Representation of the parameters passed to the filter function.
-Readonly
edmReadonly
functionReadonly
parametersCreates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=
.
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=
.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a field of an entity or a complex type, that can have a collection as value.
+Represents a field of an entity or a complex type, that can have a collection as value.
Type of the entity the field belongs to.
Type of the (de-)serializers.
Type of of elements of the collection. This can either be an EDM type or complex type.
Boolean type that represents whether the field is nullable.
Boolean type that represents whether the field is selectable.
-Creates an instance of CollectionField.
-Actual name of the field used in the OData request.
+Creates an instance of CollectionField.
+Actual name of the field used in the OData request.
The constructor of the entity or the complex type field this field belongs to.
Edm type of the field according to the metadata description.
-Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
-Readonly
_deReadonly
_entityReadonly
_fieldReadonly
_fieldReadonly
_fieldReadonly
_fieldGets the path to the complex type property represented by this.
+Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
+Representation of a filter function, that returns a collection of values.
-Representation of a filter function, that returns a collection of values.
+Creates an instance of CollectionFilterFunction.
+Creates an instance of CollectionFilterFunction.
Name of the function that returns a collection value.
Representation of the parameters passed to the filter function.
Type of the returned collection value. This influences the formatting of the returned value.
-Readonly
edmReadonly
functionReadonly
parametersCreates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=
.
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=
.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract
Represents a complex type property of an entity or a complex type.
+Abstract
Represents a complex type property of an entity or a complex type.
ComplexTypeField
s are used as static properties of entities and are generated from the metadata, i.e. for each property of
an OData entity, that has a complex type, there exists one static instance of ComplexTypeField
(or rather one of its subclasses) in the corresponding generated class file.
ComplexTypeField
s are used to represent the domain of complex or custom structures that can be used in select, filter and order by functions.
@@ -11,7 +11,7 @@
Type of complex type represented by this field.
Boolean type that represents whether the field is nullable.
Boolean type that represents whether the field is selectable.
-Creates an instance of ComplexTypeField.
+Creates an instance of ComplexTypeField.
Actual name of the field as used in the OData request.
Either the parent entity constructor of the parent complex type this field belongs to.
(De-)serializers used for transformation.
The complex type of the complex type property represented by this.
-Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
-Readonly
_complexReadonly
_entityReadonly
_fieldReadonly
_fieldOptional
Readonly
Internal
complexNote that this property is crucial, although not really used. +
Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
+Readonly
_complexReadonly
_entityReadonly
_fieldReadonly
_fieldOptional
Readonly
Internal
complexNote that this property is crucial, although not really used.
If it is removed this class becomes structural equivalent to e.g. ComplexTypeStringPropertyField which leads to unexpected behavior on the selectable
list of objects.
Readonly
deReadonly
fieldReadonly
deReadonly
fieldCreate an OData request to count entities based on the configuration of the request. +
Create an OData request to count entities based on the configuration of the request.
A CountRequestBuilder
allows only for execution of the request.
If you want to apply query parameters like filter, skip or top do it on the GetAllRequestBuilder the count is created from.
Type of the entity to be requested
-Creates an instance of CountRequestBuilder.
+Creates an instance of CountRequestBuilder.
Get all request builder to count result for.
-Readonly
getAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
@@ -32,9 +32,9 @@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.
Rest
...path: string[]Path to be appended.
+Rest
...path: string[]Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
-Protected
buildExecute request.
+Protected
buildExecute request.
Destination or DestinationFetchOptions to execute the request against.
A promise resolving to the number of entities.
Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
@@ -43,7 +43,7 @@Set middleware for requests towards the target system given in the destination.
Middlewares to be applied to the executeHttpRequest().
The request builder itself, to facilitate method chaining.
-Rest
...middlewares: HttpMiddleware[]Create the relative URL based on configuration of the given builder.
+Rest
...middlewares: HttpMiddleware[]Replace the default service path with the given custom path.
In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME>
and can be overwritten here.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract
Abstract create request class holding the parts shared in OData v2 and v4.
+Abstract
Abstract create request class holding the parts shared in OData v2 and v4.
Type of the entity to be created
-Creates an instance of CreateRequestBuilder.
+Creates an instance of CreateRequestBuilder.
Entity API for building and executing the request.
Entity to be created.
URI conversion functions.
Entity serializer.
Entity deserializer.
Object access functions for get requests.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
-Readonly
_entityReadonly
deserializerReadonly
oReadonly
responseReadonly
serializerReadonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityReadonly
deserializerReadonly
oReadonly
responseReadonly
serializerAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
@@ -47,13 +47,13 @@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.
Rest
...path: string[]Path to be appended.
+Rest
...path: string[]Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
Specifies the parent of the entity to create.
Parent of the entity to create.
Static representation of the navigation property that navigates from the parent entity to the child entity.
The entity itself, to facilitate method chaining.
-Protected
buildExecute query.
+Protected
buildExecute query.
Destination or DestinationFetchOptions to execute the request against.
A promise resolving to the created entity.
Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
@@ -64,7 +64,7 @@Set middleware for requests towards the target system given in the destination.
Middlewares to be applied to the executeHttpRequest().
The request builder itself, to facilitate method chaining.
-Rest
...middlewares: HttpMiddleware[]Create the relative URL based on configuration of the given builder.
+Rest
...middlewares: HttpMiddleware[]Replace the default service path with the given custom path.
In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME>
and can be overwritten here.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
If your entity contains fields not present in your service specification you can model them using custom fields. +
If your entity contains fields not present in your service specification you can model them using custom fields. Alternatively you can also generate a client based on a service specification containing all fields.
-Optional
isNullable: NullableTReadonly
_entityReadonly
_fieldReadonly
_fieldProtected
fieldOptional
isNullable: NullableTReadonly
_entityReadonly
_fieldReadonly
_fieldProtected
fieldAbstract
Abstract class to delete an entity holding the shared parts between OData v2 and v4.
+Abstract
Abstract class to delete an entity holding the shared parts between OData v2 and v4.
Type of the entity to be deleted
-Creates an instance of DeleteRequestBuilder. If the entity is passed, version identifier will also be added.
+Creates an instance of DeleteRequestBuilder. If the entity is passed, version identifier will also be added.
Entity API for building and executing the request.
URI conversion functions.
Entity or key-value pairs of key properties for the given entity.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
-Readonly
_entityReadonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
@@ -40,9 +40,9 @@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.
Rest
...path: string[]Path to be appended.
+Rest
...path: string[]Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
-Protected
buildExecute query.
+Protected
buildExecute query.
Destination or DestinationFetchOptions to execute the request against.
A promise resolving once the entity was deleted.
Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
@@ -50,12 +50,12 @@A promise resolving to an @sap-cloud-sdk/http-client!HttpResponse.
Gets identifier for the batch request.
Batch request identifier.
-Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.
+Set middleware for requests towards the target system given in the destination.
Middlewares to be applied to the executeHttpRequest().
The request builder itself, to facilitate method chaining.
-Rest
...middlewares: HttpMiddleware[]Create the relative URL based on configuration of the given builder.
+Rest
...middlewares: HttpMiddleware[]The request builder itself, to facilitate method chaining.
Abstract
setAbstract
setCreate the URL based on configuration of the given builder.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a property of an OData entity with an EDM type.
+Represents a property of an OData entity with an EDM type.
EdmTypeField
s are used as static properties of entities or EDM typed fields of complex type fields. They are generated from the OData metadata, i.e. for each property of
an OData entity, that has an EDM type, there is one static instance of EdmTypeField
(or rather one of its subclasses) in the corresponding generated class file.
EdmTypeField
s are used to represent the domain of more or less primitive values that can be used in select, filter and order by functions.
@@ -10,7 +10,7 @@
EDM type of the field.
Boolean type that represents whether the field is nullable.
Boolean type that represents whether the field is selectable.
-Creates an instance of EdmTypeField.
+Creates an instance of EdmTypeField.
Actual name of the field used in the OData request.
Constructor type of the entity the field belongs to.
Type of the field according to the metadata description.
(De-)serializers used for transformation.
-Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
-Dummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
-Readonly
_entityReadonly
_fieldReadonly
_fieldReadonly
_fieldReadonly
edmCreates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==
.
Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
+Dummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityReadonly
_fieldReadonly
_fieldReadonly
_fieldReadonly
edmCreates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==
.
Value to be used in the filter.
The resulting filter.
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=
.
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=
.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract
Super class for all representations of OData entity types.
-Abstract
Super class for all representations of OData entity types.
+Internal
Protected
_customA mapper representing custom fields in an entity. +
Internal
Protected
_customA mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.
-Readonly
_entityReadonly
Abstract
_oProtected
_versionThe current ETag version of the entity in the remote system. +
Readonly
_entityAbstract
Readonly
_oProtected
_versionThe current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".
-Protected
remoteThe remote state of the entity. +
Protected
remoteThe remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of the original OData properties.
-Static
_defaultStatic
_entityStatic
_serviceETag version identifier accessor.
+Static
_defaultStatic
_entityStatic
_serviceETag version identifier accessor.
The ETag version identifier of the retrieved entity, returns undefined
if not retrieved.
Protected
asCreates an object containing all defined properties, navigation properties and custom fields in the entity.
-Optional
visitedEntities: EntityBase[]List of entities to check in case of circular dependencies.
+Protected
asCreates an object containing all defined properties, navigation properties and custom fields in the entity.
+Optional
visitedEntities: EntityBase[]List of entities to check in case of circular dependencies.
EntityBase as an object with all defined entity fields.
-Protected
getOptional
visitedEntities: EntityBase[]Custom field value getter.
+Protected
getOptional
visitedEntities: EntityBase[]Returns a map that contains all entity custom fields.
@@ -56,10 +56,10 @@Protected
isValidates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
+Protected
isValidates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check.
Boolean value that describes whether a field name can be defined as custom field.
-Protected
isOptional
visitedEntities: EntityBase[]Sets a new custom field in the entity or updates it. +
Protected
isOptional
visitedEntities: EntityBase[]Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.
The name of the custom field to update.
The value of the field.
@@ -69,7 +69,7 @@The entity itself, to facilitate method chaining.
Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests.
-Optional
state: Record<string, any>State to be set as remote state.
+Optional
state: Record<string, any>State to be set as remote state.
The entity itself, to facilitate method chaining.
Set the ETag version identifier of the retrieved entity.
The returned ETag version of the entity.
@@ -77,4 +77,4 @@Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Contains the methods to build an entity.
-Contains the methods to build an entity.
+Protected
_entityReadonly
_entityBuilds the entity.
+Builds an entity from JSON representation. If you have obtained the JSON object as a request payload use the entityDeserializer methods. @@ -16,4 +16,4 @@
The custom fields you want to add.
The entity builder itself for method chaining.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a property with an enum value.
+Represents a property with an enum value.
Type of the entity the field belongs to.
Enum type that contains all valid enum entries for this field.
Boolean type that represents whether the field is nullable.
Boolean type that represents whether the field is selectable.
-Creates an instance of EnumField.
+Creates an instance of EnumField.
Actual name of the field used in the OData request.
The constructor of the entity or the complex type field this field belongs to.
-Optional
enumType: Record<string, EnumT>Enum type of the field according to the metadata description.
-Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
-Readonly
_entityReadonly
_fieldReadonly
_fieldReadonly
_fieldReadonly
edmOptional
Readonly
enumCreates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==
.
Optional
enumType: Record<string, EnumT>Enum type of the field according to the metadata description.
+Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
+Readonly
_entityReadonly
_fieldReadonly
_fieldReadonly
_fieldReadonly
edmOptional
Readonly
enumCreates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==
.
Value to be used in the filter.
The resulting filter.
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=
.
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=
.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract representation a property of an OData entity.
+Abstract representation a property of an OData entity.
Field
s are used as static properties of entities or properties of ComplexTypeFields and are generated from the metadata, i.e. for each property of
an OData entity, there exists one static instance of Field
(or rather one of its subclasses) in the corresponding generated class file.
Fields are used to represent the domain of values that can be used in select, filter and order by functions.
Type of the entity the field belongs to.
Boolean type that represents whether the field is nullable.
Boolean type that represents whether the field is selectable.
-Creates an instance of Field.
+Creates an instance of Field.
Actual name of the field used in the OData request.
Constructor type of the entity the field belongs to.
-Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
-Readonly
_entityReadonly
_fieldReadonly
_fieldPath to the field to be used in filter and order by queries.
+Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
+Field builder to orchestrate the creation of the different kinds of fields.
+Field builder to orchestrate the creation of the different kinds of fields.
Type of the entity or complex type field this field belongs to.
Type of the (de-)serializers.
-Creates an instance of FieldBuilder
.
Creates an instance of FieldBuilder
.
Entity or complex type field, for which the field builder shall create fields.
(De-)serializers used for transformation.
-Build a field for a property with a collection type. +
Build a field for a property with a collection type. The type of the field can either be an EDM type or a complex type. Fields of entities are selectable; fields of complex types are not selectable.
-Name of the field.
+Name of the field.
Type of the collection. Can either be an EDM type or complex type (not complex type field).
Whether the field is nullable.
A collection field with the given collection type.
@@ -29,4 +29,4 @@Whether the field is nullable.
A collection field with the given collection type.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a filter expression to narrow the data on a GetAllRequestBuilder request for multiple entities that match the specified criteria. +
Represents a filter expression to narrow the data on a GetAllRequestBuilder request for multiple entities that match the specified criteria.
A filter refers to the field of an entity and restricts the request based on an operator and a value. Entity.FIELD_NAME.operator(value)
.
`Product.NAME.equals('cloud-sdk')` creates a filter for the entity `Product` that matches in case the field `NAME` equals 'cloud-sdk'.
See also: {@link Filterable}.
-
+Type of the entity to be filtered on.
Type of the field to be filtered by.
-Creates an instance of Filter.
+Creates an instance of Filter.
Name of the field of the entity to be filtered on or a filter function.
Function to be used for matching.
Value to be used by the operator.
-Optional
edmType: EdmTypeShared<ODataVersionOf<EntityT>>EDM type of the field to filter on, needed for custom fields.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityEntity type of the entity tp be filtered.
+Optional
edmType: EdmTypeShared<ODataVersionOf<EntityT>>EDM type of the field to filter on, needed for custom fields.
+Optional
edmAbstract
Data structure to represent OData filter functions. +
Abstract
Data structure to represent OData filter functions.
Use the factory function filterFunction to create instances of FilterFunction
.
Creates an instance of FilterFunction.
+Creates an instance of FilterFunction.
Name of the function.
Representation of the parameters passed to the filter function.
EDM type of the return type of the filter function.
-Readonly
edmReadonly
functionReadonly
parametersCreates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=
.
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=
.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Class representing a filter expression based on a FilterLambdaOperator.
-Class representing a filter expression based on a FilterLambdaOperator.
+Data structure to represent filter on properties of a navigation property (link). +
Data structure to represent filter on properties of a navigation property (link). In OData v2 filtering for navigation properties is ONLY supported for properties with a one-to-one cardinality (OneToOneLink).
-In the following filter statement `Entity.requestBuilder().filter(Entity.to_NavProperty.filter(LinkedEntity.property.equals(value)))`,
`Entity.to_NavProperty.filter(LinkedEntity.property.equals(value))` is a `FilterLink`.
In OData v4 filtering is also possible on one-to-many links. See {@link OneToManyLink}.
-
-Type of the linked entity which is used in the filter.
+In the following filter statement `Entity.requestBuilder().filter(Entity.to_NavProperty.filter(LinkedEntity.property.equals(value)))`,
`Entity.to_NavProperty.filter(LinkedEntity.property.equals(value))` is a `FilterLink`.
In OData v4 filtering is also possible on one-to-many links. See {@link OneToManyLink}.
+
+
+Type of the linked entity which is used in the filter.
Type of the entity to be filtered.
-Creates an instance of FilterLink
.
Creates an instance of FilterLink
.
Linked entity to be used in the filter.
List of filterables for the linked entity.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityEntity type of the entity tp be filtered.
-Readonly
_linkedLinked entity to be filtered by.
+Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityEntity type of the entity tp be filtered.
+Readonly
_linkedLinked entity to be filtered by.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Data structure to combine Filterables conjunctively and / or disjunctively. A FilterList matches when all filterables within the andFilters
match and when at least one filterable within the orFilters
matches. Should not be used directly.
Data structure to combine Filterables conjunctively and / or disjunctively. A FilterList matches when all filterables within the andFilters
match and when at least one filterable within the orFilters
matches. Should not be used directly.
Creates an instance of FilterList.
-Optional
andFilters: Filterable<EntityT, DeSerializersT>[]Filters to be combined by logical conjunction (and
).
Optional
orFilters: Filterable<EntityT, DeSerializersT>[]Filters to be combined by logical disjunction (or
).
Dummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityEntity type of the entity tp be filtered.
+Creates an instance of FilterList.
+Optional
andFilters: Filterable<EntityT, DeSerializersT>[]Filters to be combined by logical conjunction (and
).
Optional
orFilters: Filterable<EntityT, DeSerializersT>[]Filters to be combined by logical disjunction (or
).
Abstract
Base class for the get all request builders GetAllRequestBuilderV2 and GetAllRequestBuilderV4.
+Abstract
Base class for the get all request builders GetAllRequestBuilderV2 and GetAllRequestBuilderV4.
Type of the entity to be requested
-Creates an instance of GetAllRequestBuilder.
+Creates an instance of GetAllRequestBuilder.
Entity API for building and executing the request.
Request config of the get all request.
Entity deserializer.
Object access functions for get requests.
-Readonly
_deReadonly
_entityReadonly
_entityReadonly
_entityReadonly
dataReadonly
entityReadonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityReadonly
_entityReadonly
dataReadonly
entityAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
@@ -43,9 +45,9 @@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.
Rest
...path: string[]Path to be appended.
+Rest
...path: string[]Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
-Protected
buildCount the number of entities.
+Protected
buildCount the number of entities.
A count request builder for execution.
Execute request.
Destination or DestinationFetchOptions to execute the request against.
@@ -56,15 +58,18 @@Set middleware for requests towards the target system given in the destination.
Middlewares to be applied to the executeHttpRequest().
The request builder itself, to facilitate method chaining.
-Rest
...middlewares: HttpMiddleware[]Add order-by statements to the request.
+Rest
...middlewares: HttpMiddleware[]Add order-by statements to the request.
OrderBy statements to order the response by.
The request builder itself, to facilitate method chaining.
-Rest
...orderBy: OrderableAndOrderableInput<EntityT, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]Create the relative URL based on configuration of the given builder.
+Rest
...orderBy: OrderableAndOrderableInput<EntityT, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]Restrict the response to the given selection of properties in the request.
-Rest
...selects: Selectable<EntityT, DeSerializersT>[]Fields to select in the request.
+Rest
...selects: Selectable<EntityT, DeSerializersT>[]Fields to select in the request.
The request builder itself, to facilitate method chaining.
-Replace the default service path with the given custom path. +
Restrict the response to the given selection of properties in the request.
+Fields to select in the request.
+The request builder itself, to facilitate method chaining.
+Replace the default service path with the given custom path.
In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME>
and can be overwritten here.
Path to override the default with.
The request builder itself, to facilitate method chaining.
@@ -80,4 +85,4 @@Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract
Abstract class to create a get by key request containing the shared functionality for OData v2 and v4.
+Abstract
Abstract class to create a get by key request containing the shared functionality for OData v2 and v4.
Type of the entity to be requested
-Creates an instance of GetByKeyRequestBuilder.
+Creates an instance of GetByKeyRequestBuilder.
Entity API for building and executing the request.
Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value.
URI conversion functions.
Entity deserializer.
Object access functions for get requests.
-Readonly
_deReadonly
_entityReadonly
_entityReadonly
_entityReadonly
dataReadonly
entityReadonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityReadonly
_entityReadonly
dataReadonly
entityAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
@@ -42,9 +44,9 @@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.
Rest
...path: string[]Path to be appended.
+Rest
...path: string[]Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
-Protected
buildExecute request.
+Protected
buildExecute request.
Destination or DestinationFetchOptions to execute the request against.
A promise resolving to the requested entity.
Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
@@ -55,12 +57,15 @@Set middleware for requests towards the target system given in the destination.
Middlewares to be applied to the executeHttpRequest().
The request builder itself, to facilitate method chaining.
-Rest
...middlewares: HttpMiddleware[]Create the relative URL based on configuration of the given builder.
+Rest
...middlewares: HttpMiddleware[]Restrict the response to the given selection of properties in the request.
-Rest
...selects: Selectable<EntityT, DeSerializersT>[]Fields to select in the request.
+Rest
...selects: Selectable<EntityT, DeSerializersT>[]Fields to select in the request.
The request builder itself, to facilitate method chaining.
-Replace the default service path with the given custom path. +
Restrict the response to the given selection of properties in the request.
+Fields to select in the request.
+The request builder itself, to facilitate method chaining.
+Replace the default service path with the given custom path.
In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME>
and can be overwritten here.
Path to override the default with.
The request builder itself, to facilitate method chaining.
@@ -72,4 +77,4 @@Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a navigation property of an OData entity.
+Represents a navigation property of an OData entity.
OData is a relational data model, i.e. entities can be related to one another. For example, BusinessPartner is in a 1:n relation with BusinessPartnerAddress and in a 1:1 relation with Customer. Like normal properties, navigation properties can be used for selecting (expanding) and filtering. @@ -8,9 +8,9 @@ OData v2 entity: 1:N is a Link, 1:0..1 is a OneToOneLink OData v4 entity: 1:N is a OneToManyLink, 1:0..1 is a OneToOneLink.
See also: Selectable.
-Type of the entity to be linked to.
+Type of the entity to be linked from.
-Creates an instance of Link.
+Creates an instance of Link.
Name of the linking field to be used in the OData request.
Entity API for building and executing the request.
Constructor of the linked entity.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
-Readonly
_entityReadonly
_fieldReadonly
_linkedList of selectables on the linked entity.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityReadonly
_fieldReadonly
_linkedList of selectables on the linked entity.
+Rest
...expands: Expandable<EntityType<LinkedEntityApiT>, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]Creates a selection on a linked entity. Has the same behavior as GetAllRequestBuilderV2.select and GetByKeyRequestBuilderV4.select but for linked entities.
+Rest
...expands: Expandable<EntityType<LinkedEntityApiT>, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]Creates a selection on a linked entity. Has the same behavior as GetAllRequestBuilderV2.select and GetByKeyRequestBuilderV4.select but for linked entities.
See also, Selectable.
-Rest
...selects: Selectable<EntityType<LinkedEntityApiT>, DeSerializersT>[]Selection of fields or links on a linked entity.
+Rest
...selects: Selectable<EntityType<LinkedEntityApiT>, DeSerializersT>[]Selection of fields or links on a linked entity.
The link itself, to facilitate method chaining.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Representation of a filter function, that returns a value of type number. This supports int, double and decimal values.
-Representation of a filter function, that returns a value of type number. This supports int, double and decimal values.
+Creates an instance of NumberFilterFunction.
+Creates an instance of NumberFilterFunction.
Name of the function that returns a numeric value.
Representation of the parameters passed to the filter function.
Type of the returned numeric value. This influences the formatting of the returned value.
-Readonly
edmReadonly
functionReadonly
parametersCreates an instance of Filter for this filter function and the given value using the operator 'ge', i.e. >=
.
Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e. >
.
Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e. <=
.
Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e. <
.
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=
.
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=
.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
OData batch request configuration for an entity type.
-OData batch request configuration for an entity type.
+Creates an instance of ODataBatchRequestConfig.
+Creates an instance of ODataBatchRequestConfig.
The default OData service path.
-Optional
boundary: stringRequest boundary for separation of subrequests. Defaults to an autogenerated value.
-Readonly
boundaryReadonly
defaultReadonly
defaultReadonly
parameterReadonly
boundaryReadonly
defaultReadonly
defaultReadonly
parameterAdd custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
Key-value pairs where the key is the name of a header property and the value is the respective value.
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
Key-value pairs where the key is the name of a query parameter and the value is the respective value.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected
prependProtected
prependOData count request configuration for an entity type.
+OData count request configuration for an entity type.
Type of the entity to setup a request for
-Creates an instance of ODataGetAllRequestConfig.
+Creates an instance of ODataGetAllRequestConfig.
Get all request builder to count result for.
-Readonly
defaultReadonly
defaultReadonly
getReadonly
parameterReadonly
defaultReadonly
defaultReadonly
getReadonly
parameterAdd custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
Key-value pairs where the key is the name of a header property and the value is the respective value.
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
Key-value pairs where the key is the name of a query parameter and the value is the respective value.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected
prependProtected
prependOData create request configuration for an entity type.
+OData create request configuration for an entity type.
Type of the entity to setup a request for
-Creates an instance of ODataRequest.
+Creates an instance of ODataRequest.
Entity API for building and executing the request.
URI conversion functions.
-Field that links the parent entity class to the child entity class.
-Readonly
defaultReadonly
defaultReadonly
entityReadonly
parameterKeys of the parent of the entity to create. Defined only when attempting to create child entities.
-Field that links the parent entity class to the child entity class.
+Readonly
defaultReadonly
defaultReadonly
entityReadonly
parameterKeys of the parent of the entity to create. Defined only when attempting to create child entities.
+Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
Key-value pairs where the key is the name of a header property and the value is the respective value.
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
Key-value pairs where the key is the name of a query parameter and the value is the respective value.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected
prependProtected
resourceProtected
prependProtected
resourceOData delete request configuration for an entity type.
+OData delete request configuration for an entity type.
Type of the entity to setup a request for
-Creates an instance of ODataDeleteRequestConfig.
+Creates an instance of ODataDeleteRequestConfig.
Entity API for building and executing the request.
URI conversion functions.
-Readonly
defaultReadonly
defaultVersion identifier.
-Readonly
entityMap containing the key name and value.
-Readonly
parameterIgnore the version identifier if set to true.
-Readonly
defaultReadonly
defaultVersion identifier.
+Readonly
entityMap containing the key name and value.
+Readonly
parameterIgnore the version identifier if set to true.
+Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
Key-value pairs where the key is the name of a header property and the value is the respective value.
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
Key-value pairs where the key is the name of a query parameter and the value is the respective value.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected
prependProtected
prependAbstract
Function request configuration for an entity type.
+Abstract
Function request configuration for an entity type.
Type of the deserializer use on the request
Type of the parameter to setup a request with
-Creates an instance of ODataFunctionRequestConfig.
+Creates an instance of ODataFunctionRequestConfig.
HTTP method for the request.
Default path of the service.
The name of the function.
Object containing the parameters with a value and additional meta information.
URI conversion functions.
-Readonly
defaultReadonly
defaultReadonly
functionProtected
oReadonly
parameterReadonly
defaultReadonly
defaultReadonly
functionProtected
oReadonly
parameterAdd custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
Key-value pairs where the key is the name of a header property and the value is the respective value.
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
Key-value pairs where the key is the name of a query parameter and the value is the respective value.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected
prependAbstract
queryAbstract
resourceProtected
prependAbstract
queryAbstract
resourceOData getAll request configuration for an entity type.
+OData getAll request configuration for an entity type.
Type of the entity to setup a request for
-Creates an instance of ODataGetAllRequestConfig.
+Creates an instance of ODataGetAllRequestConfig.
Entity API for building and executing the request.
URI conversion functions.
-Readonly
defaultReadonly
defaultReadonly
entityFilter the results based on conditions.
+Readonly
defaultReadonly
defaultReadonly
entityFilter the results based on conditions.
Order the results in, e.g., asc
or desc
order.
Readonly
parameterSelect a list of fields on the schema
property of the entity api.
Readonly
parameterSelect a list of fields on the schema
property of the entity api.
Skip a number of results in the requested set.
Limit the number of results to the given number.
-Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
Key-value pairs where the key is the name of a header property and the value is the respective value.
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
Key-value pairs where the key is the name of a query parameter and the value is the respective value.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected
prependProtected
prependOData getByKey request configuration for an entity type.
+OData getByKey request configuration for an entity type.
Type of the entity to setup a request for
-Creates an instance of ODataGetByKeyRequestConfig.
+Creates an instance of ODataGetByKeyRequestConfig.
Entity API for building and executing the request.
URI conversion functions.
-Readonly
defaultReadonly
defaultReadonly
entityMap containing the key name and value.
-Readonly
parameterSelect a list of fields on the schema
property of the entity api.
Readonly
defaultReadonly
defaultReadonly
entityMap containing the key name and value.
+Readonly
parameterSelect a list of fields on the schema
property of the entity api.
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
Key-value pairs where the key is the name of a header property and the value is the respective value.
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
Key-value pairs where the key is the name of a query parameter and the value is the respective value.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected
prependProtected
prependOData request configuration for an entity type.
-Type of the entity to setup a request for.
-OData request configuration for an entity type.
+Creates an instance of ODataRequest.
+Creates an instance of ODataRequest.
Configuration of the request.
-Optional
_destination: HttpDestinationDestination to setup the request against.
-Get all custom headers.
+Optional
_destination: HttpDestinationDestination to setup the request against.
+Returns the relative URL to a specific OData resource.
-Optional
includeBasePath: booleanWhether or not to include the base path in the URL.
+Optional
includeBasePath: booleanWhether or not to include the base path in the URL.
The relative URL of the resource.
Constructs a URL relative to the destination.
-Optional
includeBasePath: booleanWhether or not to include the base path in the URL.
-Optional
includeQueryParameters: booleanWhether or not to include the query parameters in the URL.
+Optional
includeBasePath: booleanWhether or not to include the base path in the URL.
+Optional
includeQueryParameters: booleanWhether or not to include the query parameters in the URL.
The relative URL for the request.
Abstract
Parent class for all OData request configs like getAll
, delete
or count
.
Abstract
Parent class for all OData request configs like getAll
, delete
or count
.
Creates an instance of ODataRequest.
+Creates an instance of ODataRequest.
HTTP method of the request.
Default path of the according service.
-Optional
defaultHeaders: Record<string, any>The default headers of the given request as an object.
-Readonly
defaultReadonly
defaultReadonly
parameterReadonly
defaultReadonly
defaultReadonly
parameterAdd custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
Key-value pairs where the key is the name of a header property and the value is the respective value.
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
Key-value pairs where the key is the name of a query parameter and the value is the respective value.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected
prependAbstract
queryAbstract
resourceProtected
prependAbstract
queryAbstract
resourceOData update request configuration for an entity type.
+OData update request configuration for an entity type.
Type of the entity to setup a request for
-Creates an instance of ODataUpdateRequestConfig.
+Creates an instance of ODataUpdateRequestConfig.
Entity API for building and executing the request.
URI conversion functions.
-Readonly
defaultReadonly
defaultVersion identifier.
-Readonly
entityMap containing the key name and value.
-Readonly
parameterIgnore the version identifier if set to true.
-Readonly
defaultReadonly
defaultVersion identifier.
+Readonly
entityMap containing the key name and value.
+Readonly
parameterIgnore the version identifier if set to true.
+Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
Key-value pairs where the key is the name of a header property and the value is the respective value.
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
Key-value pairs where the key is the name of a query parameter and the value is the respective value.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected
prependProtected
prependRepresents a one to many relation for OData v4 entities. +
Creates an instance of Link.
+Creates an instance of Link.
Name of the linking field to be used in the OData request.
Entity API for building and executing the request.
Constructor of the linked entity.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
-Readonly
_entityReadonly
_fieldReadonly
_linkedList of selectables on the linked entity.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityReadonly
_fieldReadonly
_linkedList of selectables on the linked entity.
+Rest
...expands: Expandable<EntityType<LinkedEntityApiT>, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]Create filter statements to be applied to the OData request based on the linked entity values.
-Rest
...expressions: (Filterable<EntityType<LinkedEntityApiT>, DeSerializersT> | OneToManyLink<EntityType<LinkedEntityApiT>, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>)[]Filters based on the linked entity.
+Rest
...expands: Expandable<EntityType<LinkedEntityApiT>, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]Create filter statements to be applied to the OData request based on the linked entity values.
+Rest
...expressions: (Filterable<EntityType<LinkedEntityApiT>, DeSerializersT> | OneToManyLink<EntityType<LinkedEntityApiT>, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>)[]Filters based on the linked entity.
Newly created FilterLink
.
Add order-by statements to the request.
-Rest
...orderBy: Orderable<EntityType<LinkedEntityApiT>>[]OrderBy statements to order the response by.
+Rest
...orderBy: Orderable<EntityType<LinkedEntityApiT>>[]OrderBy statements to order the response by.
The request builder itself, to facilitate method chaining.
Creates a selection on a linked entity. Has the same behavior as GetAllRequestBuilderV2.select and GetByKeyRequestBuilderV4.select but for linked entities.
See also, Selectable.
-Rest
...selects: Selectable<EntityType<LinkedEntityApiT>, DeSerializersT>[]Selection of fields or links on a linked entity.
+Rest
...selects: Selectable<EntityType<LinkedEntityApiT>, DeSerializersT>[]Selection of fields or links on a linked entity.
The link itself, to facilitate method chaining.
Skip number of entities.
Number of matching entities to skip. Useful for paging.
@@ -46,4 +46,4 @@Maximum number of entities to return in the response. Can be less, if less entities match the request.
The request builder itself, to facilitate method chaining.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a link from one entity to one other linked entity (as opposed to a list of linked entities). In OData v2 a OneToOneLink
can be used to filter and order a selection on an entity based on filters and orders on a linked entity.
Type of the entity to be linked to.
+Represents a link from one entity to one other linked entity (as opposed to a list of linked entities). In OData v2 a OneToOneLink
can be used to filter and order a selection on an entity based on filters and orders on a linked entity.
Type of the entity to be linked from
-Creates an instance of Link.
+Creates an instance of Link.
Name of the linking field to be used in the OData request.
Entity API for building and executing the request.
Constructor of the linked entity.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
-Readonly
_entityReadonly
_fieldReadonly
_linkedList of selectables on the linked entity.
+Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityReadonly
_fieldReadonly
_linkedList of selectables on the linked entity.
Filterables to apply to the given entity based on the linked entity.
List of criteria of the linked entity to order the given entity by with descending priority.
-Rest
...expands: Expandable<EntityType<LinkedEntityApiT>, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]Create filter statements to be applied to the OData request based on the linked entity values.
-Rest
...filters: Filterable<EntityType<LinkedEntityApiT>, DeSerializersT>[]Filters based on the linked entity.
+Rest
...expands: Expandable<EntityType<LinkedEntityApiT>, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]Create filter statements to be applied to the OData request based on the linked entity values.
+Rest
...filters: Filterable<EntityType<LinkedEntityApiT>, DeSerializersT>[]Filters based on the linked entity.
Newly created FilterLink.
Create order statements for the OData request based on the linked entity. The given statements have descending priority.
-Rest
...orderBy: Orderable<EntityType<LinkedEntityApiT>>[]Criteria to order by.
+Rest
...orderBy: Orderable<EntityType<LinkedEntityApiT>>[]Criteria to order by.
Newly created order link.
-Entity.requestBuilder()
.getAll()
.orderBy(Entity.TO_LINKED_ENTITY.orderBy(asc(LinkedEntity.PROPERTY1), desc(LinkedEntity.PROPERTY2)));
+Example
Entity.requestBuilder()
.getAll()
.orderBy(Entity.TO_LINKED_ENTITY.orderBy(asc(LinkedEntity.PROPERTY1), desc(LinkedEntity.PROPERTY2)));
+
select
- select(...selects): this
Creates a selection on a linked entity. Has the same behavior as GetAllRequestBuilderV2.select and GetByKeyRequestBuilderV4.select but for linked entities.
See also, Selectable.
-Parameters
Rest
...selects: Selectable<EntityType<LinkedEntityApiT>, DeSerializersT>[]Selection of fields or links on a linked entity.
+Parameters
Rest
...selects: Selectable<EntityType<LinkedEntityApiT>, DeSerializersT>[]Selection of fields or links on a linked entity.
Returns this
The link itself, to facilitate method chaining.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
-
Internal representation of operation parameters. It adds metadata to the value.
+Internal representation of operation parameters. It adds metadata to the value.
Creates an instance of OperationParameter.
+Creates an instance of OperationParameter.
The original name of the parameter in the OData service.
Original EDM type.
Value to be used as parameter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract
Create OData request to execute an action or function.
+Abstract
Create OData request to execute an action or function.
Type of the (de-)serializers.
Type of the function return value.
Type of the request config.
-Protected
constructorBase class for function and action request builder.
-Transformation function for the response.
+Protected
constructorBase class for function and action request builder.
+Transformation function for the response.
Request config for an action or function.
(De-)serializers used for transformation.
-Readonly
_deReadonly
responseAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
@@ -37,11 +37,11 @@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.
Rest
...path: string[]Path to be appended.
+Rest
...path: string[]Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
-Protected
buildExecute request.
+Protected
buildExecute request.
Destination or DestinationFetchOptions to execute the request against.
-Optional
dataAccessor: ((data) => any)A function to modify the received response data.
+Optional
dataAccessor: ((data: any) => any)A function to modify the received response data.
A promise resolving to the requested return type.
Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
Destination or DestinationFetchOptions to execute the request against.
@@ -51,7 +51,7 @@Set middleware for requests towards the target system given in the destination.
Middlewares to be applied to the executeHttpRequest().
The request builder itself, to facilitate method chaining.
-Rest
...middlewares: HttpMiddleware[]Create the relative URL based on configuration of the given builder.
+Rest
...middlewares: HttpMiddleware[]Replace the default service path with the given custom path.
In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME>
and can be overwritten here.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
OData queries take this to determine the order of results.
-OData queries take this to determine the order of results.
+Creates an instance of Order.
Field to order by.
-Optional
orderType: OrderTypeType of ordering, can be 'asc' for ascending or 'desc' for descending.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Optional
orderType: OrderTypeType of ordering, can be 'asc' for ascending or 'desc' for descending.
+Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Readonly
_entityReadonly
_entityLink to represent an order by on a linked entity.
-Type of the entity to link to.
+Link to represent an order by on a linked entity.
+Type of the entity to link from.
-Creates an instance of OrderLink.
+Creates an instance of OrderLink.
Link to the entity to order by.
A list of orderables based on the linked entity.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Readonly
entityReadonly
linkedEdmTypeField, that represents a property with an EDM type, that can be compared with greaterThan
, greaterOrEqual
, lessThan
and lessOrEqual
.
EdmTypeField, that represents a property with an EDM type, that can be compared with greaterThan
, greaterOrEqual
, lessThan
and lessOrEqual
.
Type of the entity the field belongs to.
EDM type of the field.
Boolean type that represents whether the field is nullable.
Boolean type that represents whether the field is selectable.
-Creates an instance of EdmTypeField.
+Creates an instance of EdmTypeField.
Actual name of the field used in the OData request.
Constructor type of the entity the field belongs to.
Type of the field according to the metadata description.
(De-)serializers used for transformation.
-Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
-Dummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
-Readonly
_entityReadonly
_fieldReadonly
_fieldReadonly
_fieldReadonly
edmCreates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==
.
Optional
fieldOptions: FieldOptions<NullableT, SelectableT>Optional settings for this field.
+Dummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityReadonly
_fieldReadonly
_fieldReadonly
_fieldReadonly
edmCreates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==
.
Value to be used in the filter.
The resulting filter.
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e. >=
.
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e. >=
.
Value to be used in the filter.
The resulting filter.
-Creates an instance of Filter for this field and the given value using the operator 'gt', i.e. >
.
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e. >
.
Value to be used in the filter.
The resulting filter.
-Creates an instance of Filter for this field and the given value using the operator 'le', i.e. <=
.
Creates an instance of Filter for this field and the given value using the operator 'le', i.e. <=
.
Value to be used in the filter.
The resulting filter.
-Creates an instance of Filter for this field and the given value using the operator 'lt', i.e. <
.
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e. <
.
Value to be used in the filter.
The resulting filter.
-Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=
.
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=
.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract
Represents a request builder for a given entity API.
-Abstract
Represents a request builder for a given entity API.
+Dummy property to also include the deserializer type in the structure of the entity type.
+Dummy property to also include the deserializer type in the structure of the entity type.
Dummy property whose type makes structurally identical entities distinguishable in TypeScript.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Representation of a filter function, that returns a value of type string.
-Representation of a filter function, that returns a value of type string.
+Creates an instance of StringFilterFunction.
+Creates an instance of StringFilterFunction.
Name of the function that returns a string value.
Representation of the parameters passed to the filter function.
-Readonly
edmReadonly
functionReadonly
parametersCreates an instance of Filter for this filter function and the given value using the operator 'ge', i.e. >=
.
Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e. >
.
Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e. <=
.
Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e. <
.
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=
.
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=
.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Class representing a unary filter which is a filter containing just a single argument e.g. not.
-Class representing a unary filter which is a filter containing just a single argument e.g. not.
+Abstract
Abstract class to create OData query to update an entity containing methods shared for OData v2 and v4.
+Abstract
Abstract class to create OData query to update an entity containing methods shared for OData v2 and v4.
Type of the entity to be updated
-Creates an instance of UpdateRequestBuilder.
+Creates an instance of UpdateRequestBuilder.
Entity API for building and executing the request.
Entity to be updated.
URI conversion functions.
Entity serializer.
-Extractor for ETag from payload.
-Manipulator for the payload.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
-Readonly
_entityReadonly
entityReadonly
extractODataReadonly
oReadonly
payloadAdd custom headers to the request. Existing headers will be overwritten.
+Extractor for ETag from payload.
+Manipulator for the payload.
+Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityReadonly
entityReadonly
extractODataReadonly
oReadonly
payloadAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
@@ -53,21 +53,21 @@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.
Rest
...path: string[]Path to be appended.
+Rest
...path: string[]Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
-Protected
buildProtected
executeExecutes the query.
+Protected
buildProtected
executeExecutes the query.
Request object to be executed.
A promise resolving to the entity once it was updated.
-Protected
executeGets identifier for the batch request.
+Protected
executeGets identifier for the batch request.
Batch request identifier.
-Protected
getInstructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.
+Protected
getProtected
isSet middleware for requests towards the target system given in the destination.
+Protected
isSet middleware for requests towards the target system given in the destination.
Middlewares to be applied to the executeHttpRequest().
The request builder itself, to facilitate method chaining.
-Rest
...middlewares: HttpMiddleware[]Create the relative URL based on configuration of the given builder.
+Rest
...middlewares: HttpMiddleware[]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.
+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.
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 basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME>
and can be overwritten here.
Sets entity fields to ignore by the update request.
-Rest
...fields: Selectable<EntityT, DeSerializersT>[]Enumeration of the fields to be ignored.
+Rest
...fields: Selectable<EntityT, DeSerializersT>[]Enumeration of the fields to be ignored.
The entity itself, to facilitate method chaining.
Sets required entity keys for the update request.
-Rest
...fields: Selectable<EntityT, DeSerializersT>[]Enumeration of the fields to be required.
+Rest
...fields: Selectable<EntityT, DeSerializersT>[]Enumeration of the fields to be required.
The entity itself, to facilitate method chaining.
Sets ETag version identifier of the entity to update.
Custom ETag version identifier to be sent in the header of the request.
@@ -90,4 +90,4 @@Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create an OData request to count entities based on the configuration of the request. +
Create an OData request to count entities based on the configuration of the request.
A CountRequestBuilder
allows only for execution of the request.
If you want to apply query parameters like filter, skip or top do it on the GetAllRequestBuilder the count is created from.
Type of the entity to be requested.
Type of the (de-)serializers.
-Creates an instance of CountRequestBuilder.
+Creates an instance of CountRequestBuilder.
Get all request builder to count result for.
-Readonly
getAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
@@ -33,9 +33,9 @@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.
Rest
...path: string[]Path to be appended.
+Rest
...path: string[]Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
-Protected
buildExecute request.
+Protected
buildExecute request.
Destination or DestinationFetchOptions to execute the request against.
A promise resolving to the number of entities.
Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
@@ -44,7 +44,7 @@Set middleware for requests towards the target system given in the destination.
Middlewares to be applied to the executeHttpRequest().
The request builder itself, to facilitate method chaining.
-Rest
...middlewares: HttpMiddleware[]Create the relative URL based on configuration of the given builder.
+Rest
...middlewares: HttpMiddleware[]Replace the default service path with the given custom path.
In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME>
and can be overwritten here.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create OData request to create an entity.
+Create OData request to create an entity.
Type of the entity to be created.
-Creates an instance of CreateRequestBuilder.
+Creates an instance of CreateRequestBuilder.
Entity API for building and executing the request.
Entity to be created.
-Readonly
_deDummy property to also include the deserializer type in the structure of the entity type.
-Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
-Readonly
_entityReadonly
deserializerReadonly
oReadonly
responseReadonly
serializerReadonly
_deDummy property to also include the deserializer type in the structure of the entity type.
+Readonly
_entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
+Readonly
_entityReadonly
deserializerReadonly
oReadonly
responseReadonly
serializerAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
@@ -43,13 +43,13 @@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.
Rest
...path: string[]Path to be appended.
+Rest
...path: string[]Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
Specifies the parent of the entity to create.
Parent of the entity to create.
Static representation of the navigation property that navigates from the parent entity to the child entity.
The entity itself, to facilitate method chaining.
-Protected
buildExecute query.
+Protected
build
Represents the selection of all fields. +
- Preparing search index...
- The search index is not available
SAP Cloud SDK for JavaScript - v3.19.0Class AllFields<EntityT>
Represents the selection of all fields. This field should be used in the schema of entities.
-Type Parameters
Index
Constructors
Type Parameters
Index
Constructors
Properties
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Constructors
constructor
Type Parameters
Parameters
Returns AllFields<EntityT>
Properties
_entity Constructor
_field Name
Readonly
selectableSettings
Member Visibility
Theme
On This Page