public interface BillOfMaterialsV2Service
This service enables you to read, create, update and Delete Bills of Material and Version Bills of Material. It 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 zero or more items for each header. .
Reference: SAP API Business Hub
OData Service: | API_BILL_OF_MATERIAL_SRV_0002 |
API Version: | 2 |
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) |
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 |
---|---|
MaterialBOMCreateFluentHelper |
createMaterialBOM(MaterialBOM materialBOM)
Create a new
MaterialBOM entity and save it to the S/4HANA system. |
MaterialBOMItemCreateFluentHelper |
createMaterialBOMItem(MaterialBOMItem materialBOMItem)
Create a new
MaterialBOMItem entity and save it to the S/4HANA system. |
MaterialBOMDeleteFluentHelper |
deleteMaterialBOM(MaterialBOM materialBOM)
Deletes an existing
MaterialBOM entity in the S/4HANA system. |
MaterialBOMItemDeleteFluentHelper |
deleteMaterialBOMItem(MaterialBOMItem materialBOMItem)
Deletes an existing
MaterialBOMItem entity in the S/4HANA system. |
ExplodeBOMFluentHelper |
explodeBOM(String billOfMaterial,
String billOfMaterialCategory,
String billOfMaterialVariant,
String billOfMaterialVersion,
String engineeringChangeDocument,
String material,
String plant,
String bOMExplosionApplication,
BigDecimal requiredQuantity,
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.
|
BillOfMaterialUsageFluentHelper |
getAllBillOfMaterialUsage()
Fetch multiple
BillOfMaterialUsage entities. |
BillOfMaterialUsageTextFluentHelper |
getAllBillOfMaterialUsageText()
Fetch multiple
BillOfMaterialUsageText entities. |
BOMItemCategoryFluentHelper |
getAllBOMItemCategory()
Fetch multiple
BOMItemCategory entities. |
BOMItemCategoryTextFluentHelper |
getAllBOMItemCategoryText()
Fetch multiple
BOMItemCategoryText entities. |
MaterialBOMFluentHelper |
getAllMaterialBOM()
Fetch multiple
MaterialBOM entities. |
MaterialBOMItemFluentHelper |
getAllMaterialBOMItem()
Fetch multiple
MaterialBOMItem entities. |
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. |
MaterialBOMByKeyFluentHelper |
getMaterialBOMByKey(String billOfMaterial,
String billOfMaterialCategory,
String billOfMaterialVariant,
String billOfMaterialVersion,
String engineeringChangeDocument,
String material,
String plant)
Fetch a single
MaterialBOM entity using key fields. |
MaterialBOMItemByKeyFluentHelper |
getMaterialBOMItemByKey(String billOfMaterial,
String billOfMaterialCategory,
String billOfMaterialVariant,
String billOfMaterialVersion,
String billOfMaterialItemNodeNumber,
String headerChangeDocument,
String material,
String plant)
Fetch a single
MaterialBOMItem entity using key fields. |
ReleaseVersionBOMFluentHelper |
releaseVersionBOM(String billOfMaterial,
String billOfMaterialCategory,
String billOfMaterialVariant,
String billOfMaterialVersion,
String engineeringChangeDocument,
String material,
String plant)
Creates a fluent helper for the ReleaseVersionBOM OData function import.
|
MaterialBOMUpdateFluentHelper |
updateMaterialBOM(MaterialBOM materialBOM)
Update an existing
MaterialBOM entity and save it to the S/4HANA system. |
MaterialBOMItemUpdateFluentHelper |
updateMaterialBOMItem(MaterialBOMItem materialBOMItem)
Update an existing
MaterialBOMItem entity and save it to the S/4HANA system. |
BillOfMaterialsV2Service |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull BillOfMaterialsV2Service withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull MaterialBOMItemFluentHelper getAllMaterialBOMItem()
MaterialBOMItem
entities.MaterialBOMItem
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 MaterialBOMItemByKeyFluentHelper getMaterialBOMItemByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String billOfMaterialItemNodeNumber, String headerChangeDocument, String material, String plant)
MaterialBOMItem
entity using key fields.headerChangeDocument
- Number used to uniquely identify a change master record.
Constraints: Not nullable, Maximum length: 12
material
- Alphanumeric key uniquely identifying the material.
Constraints: Not nullable, Maximum length: 40
billOfMaterialCategory
- This key defines a BOM according to the object (such as material or equipment) to which it is linked.
Constraints: Not nullable, Maximum length: 1
billOfMaterialVersion
- BOM Version
Constraints: Not nullable, Maximum length: 4
plant
- Key uniquely identifying a plant.
Constraints: Not nullable, Maximum length: 4
billOfMaterial
- Number used in combination with the BOM category to uniquely identify a BOM or a BOM group.
Constraints: Not nullable, Maximum length: 8
billOfMaterialVariant
- Identifies one BOM in a BOM group.
Constraints: Not nullable, Maximum length: 2
billOfMaterialItemNodeNumber
- MaterialBOMItem
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 MaterialBOMItemCreateFluentHelper createMaterialBOMItem(@Nonnull MaterialBOMItem materialBOMItem)
MaterialBOMItem
entity and save it to the S/4HANA system.materialBOMItem
- MaterialBOMItem
entity object that will be created in the S/4HANA system.MaterialBOMItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull MaterialBOMItemUpdateFluentHelper updateMaterialBOMItem(@Nonnull MaterialBOMItem materialBOMItem)
MaterialBOMItem
entity and save it to the S/4HANA system.materialBOMItem
- MaterialBOMItem
entity object that will be updated in the S/4HANA system.MaterialBOMItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull MaterialBOMItemDeleteFluentHelper deleteMaterialBOMItem(@Nonnull MaterialBOMItem materialBOMItem)
MaterialBOMItem
entity in the S/4HANA system.materialBOMItem
- MaterialBOMItem
entity object that will be deleted in the S/4HANA system.MaterialBOMItem
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 MaterialBOMFluentHelper getAllMaterialBOM()
MaterialBOM
entities.MaterialBOM
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 MaterialBOMByKeyFluentHelper getMaterialBOMByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String engineeringChangeDocument, String material, String plant)
MaterialBOM
entity using key fields.material
- Alphanumeric key uniquely identifying the material.
Constraints: Not nullable, Maximum length: 40
billOfMaterialCategory
- This key defines a BOM according to the object (such as material or equipment) to which it is linked.
Constraints: Not nullable, Maximum length: 1
billOfMaterialVersion
- BOM Version
Constraints: Not nullable, Maximum length: 4
engineeringChangeDocument
- Number used to uniquely identify a change master record.
Constraints: Not nullable, Maximum length: 12
plant
- Key uniquely identifying a plant.
Constraints: Not nullable, Maximum length: 4
billOfMaterial
- Number used in combination with the BOM category to uniquely identify a BOM or a BOM group.
Constraints: Not nullable, Maximum length: 8
billOfMaterialVariant
- Identifies one BOM in a BOM group.
Constraints: Not nullable, Maximum length: 2
MaterialBOM
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 MaterialBOMCreateFluentHelper createMaterialBOM(@Nonnull MaterialBOM materialBOM)
MaterialBOM
entity and save it to the S/4HANA system.materialBOM
- MaterialBOM
entity object that will be created in the S/4HANA system.MaterialBOM
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull MaterialBOMUpdateFluentHelper updateMaterialBOM(@Nonnull MaterialBOM materialBOM)
MaterialBOM
entity and save it to the S/4HANA system.materialBOM
- MaterialBOM
entity object that will be updated in the S/4HANA system.MaterialBOM
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull MaterialBOMDeleteFluentHelper deleteMaterialBOM(@Nonnull MaterialBOM materialBOM)
MaterialBOM
entity in the S/4HANA system.materialBOM
- MaterialBOM
entity object that will be deleted in the S/4HANA system.MaterialBOM
entity. 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(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String engineeringChangeDocument, String material, String plant, String bOMExplosionApplication, BigDecimal requiredQuantity, 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: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: BOMItmQtyIsScrapRelevant
sparePartFltrType
- Spare Part Indicator
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: SparePartFltrType
billOfMaterialVersion
- BOM Version
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: BillOfMaterialVersion
bOMExplosionLevel
- Explosion level
Constraints: Not nullable, Precision: 3, Scale: 0
Original parameter name from the Odata EDM: BOMExplosionLevel
billOfMaterial
- Bill of Material
Constraints: Not nullable, Maximum length: 8
Original parameter name from the Odata EDM: BillOfMaterial
bOMExplosionIsLimited
- Limited Explosion
Constraints: none
Original parameter name from the Odata EDM: BOMExplosionIsLimited
bOMExplosionApplication
- BOM Application
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: BOMExplosionApplication
requiredQuantity
- Base quantity
Constraints: Not nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: RequiredQuantity
material
- Material
Constraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: Material
billOfMaterialCategory
- BOM category
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: BillOfMaterialCategory
engineeringChangeDocument
- Change Number
Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: EngineeringChangeDocument
plant
- Plant
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: Plant
billOfMaterialItemCategory
- Item category
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: BillOfMaterialItemCategory
bOMExplosionIsMultilevel
- Multi-lev.
Constraints: none
Original parameter name from the Odata EDM: BOMExplosionIsMultilevel
billOfMaterialVariant
- Alternative BOM
Constraints: Not nullable, Maximum length: 2
Original parameter name from the Odata EDM: BillOfMaterialVariant
materialProvisionFltrType
- Mat. Provision Ind.
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: MaterialProvisionFltrType
bOMExplosionAssembly
- Material
Constraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: BOMExplosionAssembly
bOMExplosionDate
- Valid From
Constraints: Not nullable, Precision: 0
Original parameter name from the Odata EDM: BOMExplosionDate
execute
method on the fluent helper object.@Nonnull ReleaseVersionBOMFluentHelper releaseVersionBOM(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String engineeringChangeDocument, String material, String plant)
Creates a fluent helper for the ReleaseVersionBOM OData function import.
material
- Material
Constraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: Material
billOfMaterialCategory
- BOM category
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: BillOfMaterialCategory
billOfMaterialVersion
- BOM Version
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: BillOfMaterialVersion
engineeringChangeDocument
- Change Number
Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: EngineeringChangeDocument
plant
- Plant
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: Plant
billOfMaterial
- Bill of Material
Constraints: Not nullable, Maximum length: 8
Original parameter name from the Odata EDM: BillOfMaterial
billOfMaterialVariant
- Alternative BOM
Constraints: Not nullable, Maximum length: 2
Original parameter name from the Odata EDM: BillOfMaterialVariant
execute
method on the fluent helper object.Copyright © 2019 SAP SE. All rights reserved.