public interface BillOfMaterialsService extends BatchService<BillOfMaterialsServiceBatch>
The service enables you to read, create, and update bills of material with and without version. The service is based on the OData protocol and can be consumed in SAP Fiori apps and on other user interfaces. The service contains either no header, one header, or multiple headers for the specified material and none or more items for each header. .
Reference: SAP API Business Hub
OData Service: | API_BILL_OF_MATERIAL_SRV |
API Version: | 1 |
Communication Scenario: | Product Lifecycle Management - Master Data Integration (SAP_COM_0105) |
Scope Items: | Engineering Bill of Material - Versions Management (1NR), Engineering Bill of Material - Change Master Management (1R3), Change Manufacturing Bill of Material for Production (3LO), Mass Change Manufacturing Bill of Material for Production (3LP) |
Authentication Methods: | Basic, x509 |
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SERVICE_PATH
If no other path was provided via the
withServicePath(String) method, this is the default service path
used to access the endpoint. |
Modifier and Type | Method and Description |
---|---|
BillOfMaterialCreateFluentHelper |
createBillOfMaterial(BillOfMaterial billOfMaterial)
Create a new
BillOfMaterial entity and save it to the S/4HANA system. |
BillOfMaterialItemCreateFluentHelper |
createBillOfMaterialItem(BillOfMaterialItem billOfMaterialItem)
Create a new
BillOfMaterialItem entity and save it to the S/4HANA system. |
ExplodeBOMFluentHelper |
explodeBOM(UUID billOfMaterialHeaderUUID,
String material,
String plant,
String billOfMaterialVariant,
String bOMExplosionApplication,
BigDecimal requiredQuantity,
String engineeringChangeDocument,
Boolean bOMExplosionIsLimited,
String bOMItmQtyIsScrapRelevant,
String billOfMaterialItemCategory,
String bOMExplosionAssembly,
LocalDateTime bOMExplosionDate,
BigDecimal bOMExplosionLevel,
Boolean bOMExplosionIsMultilevel,
String materialProvisionFltrType,
String sparePartFltrType)
Creates a fluent helper for the ExplodeBOM OData function import.
|
BillOfMaterialFluentHelper |
getAllBillOfMaterial()
Fetch multiple
BillOfMaterial entities. |
BillOfMaterialItemFluentHelper |
getAllBillOfMaterialItem()
Fetch multiple
BillOfMaterialItem entities. |
BillOfMaterialUsageFluentHelper |
getAllBillOfMaterialUsage()
Fetch multiple
BillOfMaterialUsage entities. |
BillOfMaterialUsageTextFluentHelper |
getAllBillOfMaterialUsageText()
Fetch multiple
BillOfMaterialUsageText entities. |
BOMItemCategoryFluentHelper |
getAllBOMItemCategory()
Fetch multiple
BOMItemCategory entities. |
BOMItemCategoryTextFluentHelper |
getAllBOMItemCategoryText()
Fetch multiple
BOMItemCategoryText entities. |
BillOfMaterialByKeyFluentHelper |
getBillOfMaterialByKey(UUID billOfMaterialHeaderUUID)
Fetch a single
BillOfMaterial entity using key fields. |
BillOfMaterialItemByKeyFluentHelper |
getBillOfMaterialItemByKey(UUID billOfMaterialItemUUID)
Fetch a single
BillOfMaterialItem entity using key fields. |
BillOfMaterialUsageByKeyFluentHelper |
getBillOfMaterialUsageByKey(String billOfMaterialVariantUsage)
Fetch a single
BillOfMaterialUsage entity using key fields. |
BillOfMaterialUsageTextByKeyFluentHelper |
getBillOfMaterialUsageTextByKey(String language,
String billOfMaterialVariantUsage)
Fetch a single
BillOfMaterialUsageText entity using key fields. |
BOMItemCategoryByKeyFluentHelper |
getBOMItemCategoryByKey(String billOfMaterialItemCategory)
Fetch a single
BOMItemCategory entity using key fields. |
BOMItemCategoryTextByKeyFluentHelper |
getBOMItemCategoryTextByKey(String language,
String billOfMaterialItemCategory)
Fetch a single
BOMItemCategoryText entity using key fields. |
ReleaseVersionBOMFluentHelper |
releaseVersionBOM(UUID billOfMaterialHeaderUUID,
String stlnr,
String stlty,
String stlal,
String bomVersn,
String versnst,
Boolean versnlastind)
Creates a fluent helper for the ReleaseVersionBOM OData function import.
|
BillOfMaterialUpdateFluentHelper |
updateBillOfMaterial(BillOfMaterial billOfMaterial)
Update an existing
BillOfMaterial entity and save it to the S/4HANA system. |
BillOfMaterialItemUpdateFluentHelper |
updateBillOfMaterialItem(BillOfMaterialItem billOfMaterialItem)
Update an existing
BillOfMaterialItem entity and save it to the S/4HANA system. |
BillOfMaterialsService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull BillOfMaterialsService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull BillOfMaterialFluentHelper getAllBillOfMaterial()
BillOfMaterial
entities.BillOfMaterial
entities. This fluent helper allows methods which modify the underlying query to be called before
executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialByKeyFluentHelper getBillOfMaterialByKey(UUID billOfMaterialHeaderUUID)
BillOfMaterial
entity using key fields.billOfMaterialHeaderUUID
- Global identification of a BOM header change status
Constraints: Not nullable
BillOfMaterial
entity using key fields. This fluent helper allows methods which modify the underlying query to be called
before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialCreateFluentHelper createBillOfMaterial(@Nonnull BillOfMaterial billOfMaterial)
BillOfMaterial
entity and save it to the S/4HANA system.billOfMaterial
- BillOfMaterial
entity object that will be created in the S/4HANA system.BillOfMaterial
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialUpdateFluentHelper updateBillOfMaterial(@Nonnull BillOfMaterial billOfMaterial)
BillOfMaterial
entity and save it to the S/4HANA system.billOfMaterial
- BillOfMaterial
entity object that will be updated in the S/4HANA system.BillOfMaterial
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialItemFluentHelper getAllBillOfMaterialItem()
BillOfMaterialItem
entities.BillOfMaterialItem
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialItemByKeyFluentHelper getBillOfMaterialItemByKey(UUID billOfMaterialItemUUID)
BillOfMaterialItem
entity using key fields.billOfMaterialItemUUID
- Global identification of an item's change status
Constraints: Not nullable
BillOfMaterialItem
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialItemCreateFluentHelper createBillOfMaterialItem(@Nonnull BillOfMaterialItem billOfMaterialItem)
BillOfMaterialItem
entity and save it to the S/4HANA system.billOfMaterialItem
- BillOfMaterialItem
entity object that will be created in the S/4HANA system.BillOfMaterialItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialItemUpdateFluentHelper updateBillOfMaterialItem(@Nonnull BillOfMaterialItem billOfMaterialItem)
BillOfMaterialItem
entity and save it to the S/4HANA system.billOfMaterialItem
- BillOfMaterialItem
entity object that will be updated in the S/4HANA system.BillOfMaterialItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialUsageFluentHelper getAllBillOfMaterialUsage()
BillOfMaterialUsage
entities.BillOfMaterialUsage
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialUsageByKeyFluentHelper getBillOfMaterialUsageByKey(String billOfMaterialVariantUsage)
BillOfMaterialUsage
entity using key fields.billOfMaterialVariantUsage
- This key defines the area (such as engineering/design or production) where a BOM can be used.
Constraints: Not nullable, Maximum length: 1
BillOfMaterialUsage
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialUsageTextFluentHelper getAllBillOfMaterialUsageText()
BillOfMaterialUsageText
entities.BillOfMaterialUsageText
entities. This fluent helper allows methods which modify the underlying query to
be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BillOfMaterialUsageTextByKeyFluentHelper getBillOfMaterialUsageTextByKey(String language, String billOfMaterialVariantUsage)
BillOfMaterialUsageText
entity using key fields.language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
billOfMaterialVariantUsage
- This key defines the area (such as engineering/design or production) where a BOM can be used.
Constraints: Not nullable, Maximum length: 1
BillOfMaterialUsageText
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BOMItemCategoryFluentHelper getAllBOMItemCategory()
BOMItemCategory
entities.BOMItemCategory
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BOMItemCategoryByKeyFluentHelper getBOMItemCategoryByKey(String billOfMaterialItemCategory)
BOMItemCategory
entity using key fields.billOfMaterialItemCategory
- Categorization of the items in a BOM according to set criteria, such as whether they refer to an
object (for example, material master or document info record) or whether they are kept in stock.
Constraints: Not nullable, Maximum length: 1
BOMItemCategory
entity using key fields. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BOMItemCategoryTextFluentHelper getAllBOMItemCategoryText()
BOMItemCategoryText
entities.BOMItemCategoryText
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull BOMItemCategoryTextByKeyFluentHelper getBOMItemCategoryTextByKey(String language, String billOfMaterialItemCategory)
BOMItemCategoryText
entity using key fields.billOfMaterialItemCategory
- Categorization of the items in a BOM according to set criteria, such as whether they refer to an
object (for example, material master or document info record) or whether they are kept in stock.
Constraints: Not nullable, Maximum length: 1
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
BOMItemCategoryText
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ExplodeBOMFluentHelper explodeBOM(UUID billOfMaterialHeaderUUID, String material, String plant, String billOfMaterialVariant, String bOMExplosionApplication, BigDecimal requiredQuantity, String engineeringChangeDocument, Boolean bOMExplosionIsLimited, String bOMItmQtyIsScrapRelevant, String billOfMaterialItemCategory, String bOMExplosionAssembly, LocalDateTime bOMExplosionDate, BigDecimal bOMExplosionLevel, Boolean bOMExplosionIsMultilevel, String materialProvisionFltrType, String sparePartFltrType)
Creates a fluent helper for the ExplodeBOM OData function import.
bOMItmQtyIsScrapRelevant
- Exceptions
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: BOMItmQtyIsScrapRelevant
sparePartFltrType
- Spare Part Indicator
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: SparePartFltrType
bOMExplosionLevel
- Explosion level
Constraints: Nullable, Precision: 3, Scale: 0
Original parameter name from the Odata EDM: BOMExplosionLevel
bOMExplosionIsLimited
- Limited Explosion
Constraints: Nullable
Original parameter name from the Odata EDM: BOMExplosionIsLimited
bOMExplosionApplication
- BOM Application
Constraints: Nullable, Maximum length: 4
Original parameter name from the Odata EDM: BOMExplosionApplication
requiredQuantity
- Base quantity
Constraints: Nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: RequiredQuantity
material
- Material
Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: Material
billOfMaterialHeaderUUID
- ID hdr chge status
Constraints: none
Original parameter name from the Odata EDM: BillOfMaterialHeaderUUID
plant
- Plant
Constraints: Nullable, Maximum length: 4
Original parameter name from the Odata EDM: Plant
engineeringChangeDocument
- Change Number
Constraints: Nullable, Maximum length: 12
Original parameter name from the Odata EDM: EngineeringChangeDocument
billOfMaterialItemCategory
- Item category
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: BillOfMaterialItemCategory
bOMExplosionIsMultilevel
- Multi-lev.
Constraints: Nullable
Original parameter name from the Odata EDM: BOMExplosionIsMultilevel
billOfMaterialVariant
- Alternative BOM
Constraints: Nullable, Maximum length: 2
Original parameter name from the Odata EDM: BillOfMaterialVariant
materialProvisionFltrType
- Mat. Provision Ind.
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: MaterialProvisionFltrType
bOMExplosionAssembly
- Material
Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: BOMExplosionAssembly
bOMExplosionDate
- Valid From
Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: BOMExplosionDate
execute
method on the fluent helper object.@Nonnull ReleaseVersionBOMFluentHelper releaseVersionBOM(UUID billOfMaterialHeaderUUID, String stlnr, String stlty, String stlal, String bomVersn, String versnst, Boolean versnlastind)
Creates a fluent helper for the ReleaseVersionBOM OData function import.
stlnr
- Bill of Material
Constraints: Nullable, Maximum length: 8
Original parameter name from the Odata EDM: Stlnr
billOfMaterialHeaderUUID
- ID hdr chge status
Constraints: none
Original parameter name from the Odata EDM: BillOfMaterialHeaderUUID
versnlastind
- Latest Version
Constraints: Nullable
Original parameter name from the Odata EDM: Versnlastind
stlty
- BOM category
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: Stlty
versnst
- BOM Version Status
Constraints: Nullable, Maximum length: 2
Original parameter name from the Odata EDM: Versnst
stlal
- Alternative BOM
Constraints: Nullable, Maximum length: 2
Original parameter name from the Odata EDM: Stlal
bomVersn
- BOM Version
Constraints: Nullable, Maximum length: 4
Original parameter name from the Odata EDM: BomVersn
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.