@sap/cloud-sdk-vdm-product-allocation-object-service

This package contains the OData VDM for the Product Allocation Object Service of SAP S/4HANA Cloud. This service is part of the following communication scenarios: Product Allocation Object Integration (SAP_COM_0152). You can find additional documentation for this service on help.sap.com.

Helpful Links

Index

Modules

DummyFunctionImportResult

Classes

Interfaces

Type aliases

Variables

defaultProductAllocationObjectServicePath

Functions

Object literals

functionImports

Type aliases

ReadProductAllocationObjectServiceRequestBuilder

ReadProductAllocationObjectServiceRequestBuilder: GetAllRequestBuilder<ProdAllocationObject> | GetAllRequestBuilder<ProdAllocationObjectT> | GetAllRequestBuilder<ProdAllocCharcMetaData> | GetAllRequestBuilder<ProdAllocCharcValCombn> | GetAllRequestBuilder<ProdAllocObjTimeSeries> | GetByKeyRequestBuilder<ProdAllocationObject> | GetByKeyRequestBuilder<ProdAllocationObjectT> | GetByKeyRequestBuilder<ProdAllocCharcMetaData> | GetByKeyRequestBuilder<ProdAllocCharcValCombn> | GetByKeyRequestBuilder<ProdAllocObjTimeSeries>

WriteProductAllocationObjectServiceRequestBuilder

WriteProductAllocationObjectServiceRequestBuilder: CreateRequestBuilder<ProdAllocationObject> | UpdateRequestBuilder<ProdAllocationObject> | DeleteRequestBuilder<ProdAllocationObject> | CreateRequestBuilder<ProdAllocationObjectT> | UpdateRequestBuilder<ProdAllocationObjectT> | DeleteRequestBuilder<ProdAllocationObjectT> | CreateRequestBuilder<ProdAllocCharcMetaData> | UpdateRequestBuilder<ProdAllocCharcMetaData> | DeleteRequestBuilder<ProdAllocCharcMetaData> | CreateRequestBuilder<ProdAllocCharcValCombn> | UpdateRequestBuilder<ProdAllocCharcValCombn> | DeleteRequestBuilder<ProdAllocCharcValCombn> | CreateRequestBuilder<ProdAllocObjTimeSeries> | UpdateRequestBuilder<ProdAllocObjTimeSeries> | DeleteRequestBuilder<ProdAllocObjTimeSeries>

Variables

Const defaultProductAllocationObjectServicePath

defaultProductAllocationObjectServicePath: "/sap/opu/odata/sap/API_PRODUCT_ALLOCATION_OBJECT_SRV" = "/sap/opu/odata/sap/API_PRODUCT_ALLOCATION_OBJECT_SRV"

Functions

batch

batch(...requests: Array<ReadProductAllocationObjectServiceRequestBuilder | ODataBatchChangeSet<WriteProductAllocationObjectServiceRequestBuilder>>): ODataBatchRequestBuilder

- Defined in packages/vdm/product-allocation-object-service/BatchRequest.ts:14
Batch builder for operations supported on the Product Allocation Object Service.

Parameters
- Rest ...requests: Array<ReadProductAllocationObjectServiceRequestBuilder | ODataBatchChangeSet<WriteProductAllocationObjectServiceRequestBuilder>>
  
  The requests of the batch
Returns ODataBatchRequestBuilder

A request builder for batch.

changeset

changeset(...requests: WriteProductAllocationObjectServiceRequestBuilder[]): ODataBatchChangeSet<WriteProductAllocationObjectServiceRequestBuilder>

- Defined in packages/vdm/product-allocation-object-service/BatchRequest.ts:23
Change set constructor consists of write operations supported on the Product Allocation Object Service.

Parameters
- Rest ...requests: WriteProductAllocationObjectServiceRequestBuilder[]
  
  The requests of the change set
Returns ODataBatchChangeSet<WriteProductAllocationObjectServiceRequestBuilder>

A change set for batch.

createDummyFunctionImportResult

createDummyFunctionImportResult(json: any): DummyFunctionImportResult

- Defined in packages/vdm/product-allocation-object-service/DummyFunctionImportResult.ts:22
deprecated

since v1.6.0. Use DummyFunctionImportResult.build instead.

Parameters
- json: any
Returns DummyFunctionImportResult

deleteActiveTimeSeries

deleteActiveTimeSeries(parameters: DeleteActiveTimeSeriesParameters): FunctionImportRequestBuilder<DeleteActiveTimeSeriesParameters, ProdAllocObjTimeSeries>

- Defined in packages/vdm/product-allocation-object-service/function-imports.ts:108
Invoke action DeleteActiveTimeSeries.

Parameters
- parameters: DeleteActiveTimeSeriesParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<DeleteActiveTimeSeriesParameters, ProdAllocObjTimeSeries>

A request builder that allows to overwrite some of the values and execute the resultng request.

deleteActvCharcValCombination

deleteActvCharcValCombination(parameters: DeleteActvCharcValCombinationParameters): FunctionImportRequestBuilder<DeleteActvCharcValCombinationParameters, ProdAllocCharcValCombn>

- Defined in packages/vdm/product-allocation-object-service/function-imports.ts:31
Invoke action DeleteActvCharcValCombination.

Parameters
- parameters: DeleteActvCharcValCombinationParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<DeleteActvCharcValCombinationParameters, ProdAllocCharcValCombn>

A request builder that allows to overwrite some of the values and execute the resultng request.

setLifecycleStatusToActive

setLifecycleStatusToActive(parameters: SetLifecycleStatusToActiveParameters): FunctionImportRequestBuilder<SetLifecycleStatusToActiveParameters, DummyFunctionImportResult>

- Defined in packages/vdm/product-allocation-object-service/function-imports.ts:56
Invoke action SetLifecycleStatusToActive.

Parameters
- parameters: SetLifecycleStatusToActiveParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<SetLifecycleStatusToActiveParameters, DummyFunctionImportResult>

A request builder that allows to overwrite some of the values and execute the resultng request.

setLifecycleStatusToInactive

setLifecycleStatusToInactive(parameters: SetLifecycleStatusToInactiveParameters): FunctionImportRequestBuilder<SetLifecycleStatusToInactiveParameters, DummyFunctionImportResult>

- Defined in packages/vdm/product-allocation-object-service/function-imports.ts:80
Invoke action SetLifecycleStatusToInactive.

Parameters
- parameters: SetLifecycleStatusToInactiveParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<SetLifecycleStatusToInactiveParameters, DummyFunctionImportResult>

A request builder that allows to overwrite some of the values and execute the resultng request.

Object literals

Const functionImports

functionImports: object

deleteActiveTimeSeries

deleteActiveTimeSeries: deleteActiveTimeSeries

deleteActvCharcValCombination

deleteActvCharcValCombination: deleteActvCharcValCombination

setLifecycleStatusToActive

setLifecycleStatusToActive: setLifecycleStatusToActive

setLifecycleStatusToInactive

setLifecycleStatusToInactive: setLifecycleStatusToInactive

@sap/cloud-sdk-vdm-product-allocation-object-service

Helpful Links

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ReadProductAllocationObjectServiceRequestBuilder

WriteProductAllocationObjectServiceRequestBuilder

Variables

Const defaultProductAllocationObjectServicePath

Functions

batch

Parameters

Rest ...requests: Array<ReadProductAllocationObjectServiceRequestBuilder | ODataBatchChangeSet<WriteProductAllocationObjectServiceRequestBuilder>>

Returns ODataBatchRequestBuilder

changeset

Parameters

Rest ...requests: WriteProductAllocationObjectServiceRequestBuilder[]

Returns ODataBatchChangeSet<WriteProductAllocationObjectServiceRequestBuilder>

createDummyFunctionImportResult

Parameters

json: any

Returns DummyFunctionImportResult

deleteActiveTimeSeries

Parameters

parameters: DeleteActiveTimeSeriesParameters

Returns FunctionImportRequestBuilder<DeleteActiveTimeSeriesParameters, ProdAllocObjTimeSeries>

deleteActvCharcValCombination

Parameters

parameters: DeleteActvCharcValCombinationParameters

Returns FunctionImportRequestBuilder<DeleteActvCharcValCombinationParameters, ProdAllocCharcValCombn>

setLifecycleStatusToActive

Parameters

parameters: SetLifecycleStatusToActiveParameters

Returns FunctionImportRequestBuilder<SetLifecycleStatusToActiveParameters, DummyFunctionImportResult>

setLifecycleStatusToInactive

Parameters

parameters: SetLifecycleStatusToInactiveParameters

Returns FunctionImportRequestBuilder<SetLifecycleStatusToInactiveParameters, DummyFunctionImportResult>

Object literals

Const functionImports

deleteActiveTimeSeries

deleteActvCharcValCombination

setLifecycleStatusToActive

setLifecycleStatusToInactive