public interface OrderBillOfMaterialService extends BatchService<OrderBillOfMaterialServiceBatch>
The service contains either no header, one header, or multiple headers for the specified order bill of material and zero or more items for each header. The required information is sent in the request as a payload to create, update, or delete order bill of material and items, make appropriate checks for restricted values. If there are any issues when the order bill of material is created, updated, or deleted, the system displays error messages in the response..
Reference: SAP API Business Hub
OData Service: | API_ORDER_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), Make-to-Order Production - Finished Goods Sales and Final Assembly (BJE) |
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 |
---|---|
SalesOrderBOMCreateFluentHelper |
createSalesOrderBOM(SalesOrderBOM salesOrderBOM)
Create a new
SalesOrderBOM entity and save it to the S/4HANA system. |
SalesOrderBOMItemCreateFluentHelper |
createSalesOrderBOMItem(SalesOrderBOMItem salesOrderBOMItem)
Create a new
SalesOrderBOMItem entity and save it to the S/4HANA system. |
DeleteBOMHdrWithChangeNumberFluentHelper |
deleteBOMHdrWithChangeNumber(String billOfMaterialCategory,
String billOfMaterial,
String billOfMaterialVariant,
String engineeringChangeDocument,
String material,
String plant,
String engineeringChangeDocForEdit)
Creates a fluent helper for the DeleteBOMHdrWithChangeNumber OData function import.
|
DeleteBOMItemWithChangeNumberFluentHelper |
deleteBOMItemWithChangeNumber(String billOfMaterial,
String billOfMaterialCategory,
String billOfMaterialVariant,
String billOfMaterialItemNodeNumber,
String headerChangeDocument,
String material,
String plant,
String engineeringChangeDocForEdit)
Creates a fluent helper for the DeleteBOMItemWithChangeNumber OData function import.
|
SalesOrderBOMDeleteFluentHelper |
deleteSalesOrderBOM(SalesOrderBOM salesOrderBOM)
Deletes an existing
SalesOrderBOM entity in the S/4HANA system. |
SalesOrderBOMItemDeleteFluentHelper |
deleteSalesOrderBOMItem(SalesOrderBOMItem salesOrderBOMItem)
Deletes an existing
SalesOrderBOMItem entity in the S/4HANA system. |
BOMItemCategoryFluentHelper |
getAllBOMItemCategory()
Fetch multiple
BOMItemCategory entities. |
BOMItemCategoryTextFluentHelper |
getAllBOMItemCategoryText()
Fetch multiple
BOMItemCategoryText entities. |
SalesOrderBOMFluentHelper |
getAllSalesOrderBOM()
Fetch multiple
SalesOrderBOM entities. |
SalesOrderBOMItemFluentHelper |
getAllSalesOrderBOMItem()
Fetch multiple
SalesOrderBOMItem entities. |
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. |
SalesOrderBOMByKeyFluentHelper |
getSalesOrderBOMByKey(String billOfMaterialCategory,
String billOfMaterial,
String billOfMaterialVariant,
String engineeringChangeDocument,
String material,
String plant)
Fetch a single
SalesOrderBOM entity using key fields. |
SalesOrderBOMItemByKeyFluentHelper |
getSalesOrderBOMItemByKey(String billOfMaterial,
String billOfMaterialCategory,
String billOfMaterialVariant,
String billOfMaterialItemNodeNumber,
String headerChangeDocument,
String material,
String plant)
Fetch a single
SalesOrderBOMItem entity using key fields. |
SalesOrderBOMUpdateFluentHelper |
updateSalesOrderBOM(SalesOrderBOM salesOrderBOM)
Update an existing
SalesOrderBOM entity and save it to the S/4HANA system. |
SalesOrderBOMItemUpdateFluentHelper |
updateSalesOrderBOMItem(SalesOrderBOMItem salesOrderBOMItem)
Update an existing
SalesOrderBOMItem entity and save it to the S/4HANA system. |
OrderBillOfMaterialService |
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 OrderBillOfMaterialService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@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 SalesOrderBOMFluentHelper getAllSalesOrderBOM()
SalesOrderBOM
entities.SalesOrderBOM
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 SalesOrderBOMByKeyFluentHelper getSalesOrderBOMByKey(String billOfMaterialCategory, String billOfMaterial, String billOfMaterialVariant, String engineeringChangeDocument, String material, String plant)
SalesOrderBOM
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
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
SalesOrderBOM
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 SalesOrderBOMCreateFluentHelper createSalesOrderBOM(@Nonnull SalesOrderBOM salesOrderBOM)
SalesOrderBOM
entity and save it to the S/4HANA system.salesOrderBOM
- SalesOrderBOM
entity object that will be created in the S/4HANA system.SalesOrderBOM
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderBOMUpdateFluentHelper updateSalesOrderBOM(@Nonnull SalesOrderBOM salesOrderBOM)
SalesOrderBOM
entity and save it to the S/4HANA system.salesOrderBOM
- SalesOrderBOM
entity object that will be updated in the S/4HANA system.SalesOrderBOM
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderBOMDeleteFluentHelper deleteSalesOrderBOM(@Nonnull SalesOrderBOM salesOrderBOM)
SalesOrderBOM
entity in the S/4HANA system.salesOrderBOM
- SalesOrderBOM
entity object that will be deleted in the S/4HANA system.SalesOrderBOM
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderBOMItemFluentHelper getAllSalesOrderBOMItem()
SalesOrderBOMItem
entities.SalesOrderBOMItem
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 SalesOrderBOMItemByKeyFluentHelper getSalesOrderBOMItemByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialItemNodeNumber, String headerChangeDocument, String material, String plant)
SalesOrderBOMItem
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
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
- BOM item node number
Constraints: Not nullable, Maximum length: 8
SalesOrderBOMItem
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 SalesOrderBOMItemCreateFluentHelper createSalesOrderBOMItem(@Nonnull SalesOrderBOMItem salesOrderBOMItem)
SalesOrderBOMItem
entity and save it to the S/4HANA system.salesOrderBOMItem
- SalesOrderBOMItem
entity object that will be created in the S/4HANA system.SalesOrderBOMItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderBOMItemUpdateFluentHelper updateSalesOrderBOMItem(@Nonnull SalesOrderBOMItem salesOrderBOMItem)
SalesOrderBOMItem
entity and save it to the S/4HANA system.salesOrderBOMItem
- SalesOrderBOMItem
entity object that will be updated in the S/4HANA system.SalesOrderBOMItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderBOMItemDeleteFluentHelper deleteSalesOrderBOMItem(@Nonnull SalesOrderBOMItem salesOrderBOMItem)
SalesOrderBOMItem
entity in the S/4HANA system.salesOrderBOMItem
- SalesOrderBOMItem
entity object that will be deleted in the S/4HANA system.SalesOrderBOMItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull DeleteBOMHdrWithChangeNumberFluentHelper deleteBOMHdrWithChangeNumber(String billOfMaterialCategory, String billOfMaterial, String billOfMaterialVariant, String engineeringChangeDocument, String material, String plant, String engineeringChangeDocForEdit)
Creates a fluent helper for the DeleteBOMHdrWithChangeNumber 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
engineeringChangeDocForEdit
- Change Number
Constraints: Nullable, Maximum length: 12
Original parameter name from the Odata EDM: EngineeringChangeDocForEdit
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.@Nonnull DeleteBOMItemWithChangeNumberFluentHelper deleteBOMItemWithChangeNumber(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialItemNodeNumber, String headerChangeDocument, String material, String plant, String engineeringChangeDocForEdit)
Creates a fluent helper for the DeleteBOMItemWithChangeNumber OData function import.
headerChangeDocument
- Change Number
Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: HeaderChangeDocument
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
engineeringChangeDocForEdit
- Change Number
Constraints: Nullable, Maximum length: 12
Original parameter name from the Odata EDM: EngineeringChangeDocForEdit
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
billOfMaterialItemNodeNumber
- Item node
Constraints: Not nullable, Maximum length: 8
Original parameter name from the Odata EDM: BillOfMaterialItemNodeNumber
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.