Readonly selectableRepresentation of a batch change set, which holds a collection of write operations.
-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.
+Representation of a batch change set, which holds a collection of write operations.
+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.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Readonly boundaryReadonly requestsReadonly boundaryReadonly requestsRepresentation of a filter function, that returns a value of type boolean.
-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 'eq', i.e. ==.
Value to be used in the filter.
+Representation of a filter function, that returns a value of type boolean.
+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. !=.
Value to be used in the filter.
+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.
-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.
-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.
+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.
+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 _fieldRepresentation of a filter function, that returns a collection of values.
-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 'eq', i.e. ==.
Value to be used in the filter.
+Representation of a filter function, that returns a collection of values.
+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. !=.
Value to be used in the filter.
+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.
ComplexTypeFields 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.
ComplexTypeFields are used to represent the domain of complex or custom structures that can be used in select, filter and order by functions.
@@ -6,29 +6,29 @@
can be supplied as argument to the select function, e.g. TimeSheetEntry.TIME_SHEET_DATA_FIELDS.
Moreover, classes implementing this abstract class will provide property fields, that can be used for filtering and ordering.
See also: Selectable.
-Type of the entity the field belongs to.
-Type of the (de-)serializers.
-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.
-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. +
Type of the entity the field belongs to.
+Type of the (de-)serializers.
+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.
+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.
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.
-Get all request builder to count result for.
-Readonly getAdd custom headers to the request. Existing headers will be overwritten.
-Key-value pairs denoting additional custom headers.
+Type of the entity to be requested
+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.
-Key-value pairs denoting additional custom query parameters to be set in the request.
+Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Key-value pairs denoting additional custom query parameters to be set in the request.
The request builder itself, to facilitate method chaining.
-Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +
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.
-Key-value pairs denoting additional custom request configuration options to be set in the request.
+Key-value pairs denoting additional custom request configuration options to be set in the request.
The request builder itself, to facilitate method chaining.
-Append the given path to the URL. +
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.
-Destination or DestinationFetchOptions to execute the request against.
+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.
-Destination or DestinationFetchOptions to execute the request against.
+Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
+Destination or DestinationFetchOptions to execute the request against.
A promise resolving to an @sap-cloud-sdk/http-client!HttpResponse.
-Set middleware for requests towards the target system given in the destination.
-Middlewares to be applied to the executeHttpRequest().
+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. +
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.
+Path to override the default with.
The request builder itself, to facilitate method chaining.
-Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+Create the URL based on configuration of the given builder.
-Destination or DestinationFetchOptions to execute the request against.
+Create 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.
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.
-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 serializerAdd custom headers to the request. Existing headers will be overwritten.
-Key-value pairs denoting additional custom headers.
+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.
+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 serializerAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
-Key-value pairs denoting additional custom query parameters to be set in the request.
+Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Key-value pairs denoting additional custom query parameters to be set in the request.
The request builder itself, to facilitate method chaining.
-Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +
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.
-Key-value pairs denoting additional custom request configuration options to be set in the request.
+Key-value pairs denoting additional custom request configuration options to be set in the request.
The request builder itself, to facilitate method chaining.
-Append the given path to the URL. +
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.
+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.
-Destination or DestinationFetchOptions to execute the request against.
+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.
-Destination or DestinationFetchOptions to execute the request against.
+Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
+Destination or DestinationFetchOptions to execute the request against.
A promise resolving to an @sap-cloud-sdk/http-client!HttpResponse.
-Gets identifier for the batch request.
+Gets identifier for the batch request.
Batch request identifier.
-Set middleware for requests towards the target system given in the destination.
-Middlewares to be applied to the executeHttpRequest().
+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. +
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.
+Path to override the default with.
The request builder itself, to facilitate method chaining.
-Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+Create the URL based on configuration of the given builder.
-Destination or DestinationFetchOptions to execute the request against.
+Create 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.
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.
-Type of the entity to be deleted
-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 _entityAdd custom headers to the request. Existing headers will be overwritten.
-Key-value pairs denoting additional custom headers.
+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.
+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 _entityAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
-Key-value pairs denoting additional custom query parameters to be set in the request.
+Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Key-value pairs denoting additional custom query parameters to be set in the request.
The request builder itself, to facilitate method chaining.
-Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +
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.
-Key-value pairs denoting additional custom request configuration options to be set in the request.
+Key-value pairs denoting additional custom request configuration options to be set in the request.
The request builder itself, to facilitate method chaining.
-Append the given path to the URL. +
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.
-Destination or DestinationFetchOptions to execute the request against.
+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.
-Destination or DestinationFetchOptions to execute the request against.
+Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
+Destination or DestinationFetchOptions to execute the request against.
A promise resolving to an @sap-cloud-sdk/http-client!HttpResponse.
-Gets identifier for the batch request.
+Gets identifier for the batch request.
Batch request identifier.
-
Represents the selection of all fields. +
- Preparing search index...
- The search index is not available
SAP Cloud SDK for JavaScript - v3.12.0Class AllFields<EntityT>
Represents the selection of all fields. This field should be used in the schema of entities.
-Type Parameters
Index
Constructors
Properties
Type Parameters
EntityT extends EntityBase
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
_field
ReadonlyselectableSettings
Member Visibility
Theme
On This Page