public interface ProcessOrderService extends BatchService<ProcessOrderServiceBatch>
In addition to create, read, and update, you can also release process orders and operations. This service also enables you to schedule process order operations, technically complete and close process orders as well as set the deletion flag and deletion indicator.
Reference: SAP API Business Hub
OData Service: | API_PROCESS_ORDERS |
API Version: | 1 |
Communication Scenario: | Production Planning Integration (SAP_COM_0104), Manufacturing Execution - Order and Confirmation Integration (SAP_COM_0522) |
Scope Items: | Make-to-Stock Production - Discrete Manufacturing (BJ5), Make-to-Stock - Process Manufacturing Based on Process Order (BJ8), Material Requirements Planning (J44), Third-Party Shop Floor Execution - Process Industry (3W3), Third-Party Shop Floor Execution - Discrete Industry (3W4) |
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 |
---|---|
CloseOrderFluentHelper |
closeOrder(String manufacturingOrder)
Creates a fluent helper for the CloseOrder OData function import.
|
ConvertPlndOrderFluentHelper |
convertPlndOrder(String plannedOrder,
String manufacturingOrderType,
String manufacturingOrder)
Creates a fluent helper for the ConvertPlndOrder OData function import.
|
FunctionMessageCreateFluentHelper |
createFunctionMessage(FunctionMessage functionMessage)
Create a new
FunctionMessage entity and save it to the S/4HANA system. |
ProcessOrderCreateFluentHelper |
createProcessOrder(ProcessOrder processOrder)
Create a new
ProcessOrder
entity and save it to the S/4HANA system. |
FunctionMessageDeleteFluentHelper |
deleteFunctionMessage(FunctionMessage functionMessage)
Deletes an existing
FunctionMessage entity in the S/4HANA system. |
DeletionFlagOrderFluentHelper |
deletionFlagOrder(String manufacturingOrder)
Creates a fluent helper for the DeletionFlagOrder OData function import.
|
DeletionIndOrderFluentHelper |
deletionIndOrder(String manufacturingOrder)
Creates a fluent helper for the DeletionIndOrder OData function import.
|
DiscardOrderFluentHelper |
discardOrder(String manufacturingOrder)
Creates a fluent helper for the DiscardOrder OData function import.
|
FunctionMessageFluentHelper |
getAllFunctionMessage()
Fetch multiple
FunctionMessage entities. |
ProcessOrderFluentHelper |
getAllProcessOrder()
Fetch multiple
ProcessOrder
entities. |
ProcessOrderComponentFluentHelper |
getAllProcessOrderComponent()
Fetch multiple
ProcessOrderComponent entities. |
ProcessOrderItemFluentHelper |
getAllProcessOrderItem()
Fetch multiple
ProcessOrderItem entities. |
ProcessOrderOperationFluentHelper |
getAllProcessOrderOperation()
Fetch multiple
ProcessOrderOperation entities. |
ProcessOrderStatusFluentHelper |
getAllProcessOrderStatus()
Fetch multiple
ProcessOrderStatus entities. |
FunctionMessageByKeyFluentHelper |
getFunctionMessageByKey(String message)
Fetch a single
FunctionMessage entity using key fields. |
ProcessOrderByKeyFluentHelper |
getProcessOrderByKey(String processOrder)
Fetch a single
ProcessOrder
entity using key fields. |
ProcessOrderComponentByKeyFluentHelper |
getProcessOrderComponentByKey(String reservation,
String reservationItem)
Fetch a single
ProcessOrderComponent entity using key fields. |
ProcessOrderItemByKeyFluentHelper |
getProcessOrderItemByKey(String manufacturingOrder,
String manufacturingOrderItem)
Fetch a single
ProcessOrderItem entity using key fields. |
ProcessOrderOperationByKeyFluentHelper |
getProcessOrderOperationByKey(String orderInternalBillOfOperations,
String orderIntBillOfOperationsItem)
Fetch a single
ProcessOrderOperation entity using key fields. |
ProcessOrderStatusByKeyFluentHelper |
getProcessOrderStatusByKey(String manufacturingOrder,
String statusCode)
Fetch a single
ProcessOrderStatus entity using key fields. |
ReleaseOperationFluentHelper |
releaseOperation(String manufacturingOrder,
String manufacturingOrderOperation)
Creates a fluent helper for the ReleaseOperation OData function import.
|
ReleaseOrderFluentHelper |
releaseOrder(String manufacturingOrder)
Creates a fluent helper for the ReleaseOrder OData function import.
|
ScheduleProcessOrderOperationFluentHelper |
scheduleProcessOrderOperation(String manufacturingOrder,
String orderInternalBillOfOperations,
String orderIntBillOfOperationsItem,
LocalDateTime opSchedldStartDate,
LocalTime opSchedldStartTime,
LocalDateTime opSchedldEndDate,
LocalTime opSchedldEndTime,
String opSchedulingMode,
String opSchedulingStatus,
String opSchedulingStrategy)
Creates a fluent helper for the ScheduleProcessOrderOperation OData function import.
|
TechlyCmpltOrderFluentHelper |
techlyCmpltOrder(String manufacturingOrder)
Creates a fluent helper for the TechlyCmpltOrder OData function import.
|
FunctionMessageUpdateFluentHelper |
updateFunctionMessage(FunctionMessage functionMessage)
Update an existing
FunctionMessage entity and save it to the S/4HANA system. |
ProcessOrderUpdateFluentHelper |
updateProcessOrder(ProcessOrder processOrder)
Update an existing
ProcessOrder entity and save it to the S/4HANA system. |
ProcessOrderService |
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 ProcessOrderService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull FunctionMessageFluentHelper getAllFunctionMessage()
FunctionMessage
entities.FunctionMessage
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 FunctionMessageByKeyFluentHelper getFunctionMessageByKey(String message)
FunctionMessage
entity using key fields.message
- Message text
Constraints: Not nullable, Maximum length: 220
FunctionMessage
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 FunctionMessageCreateFluentHelper createFunctionMessage(@Nonnull FunctionMessage functionMessage)
FunctionMessage
entity and save it to the S/4HANA system.functionMessage
- FunctionMessage
entity object that will be created in the S/4HANA system.FunctionMessage
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull FunctionMessageUpdateFluentHelper updateFunctionMessage(@Nonnull FunctionMessage functionMessage)
FunctionMessage
entity and save it to the S/4HANA system.functionMessage
- FunctionMessage
entity object that will be updated in the S/4HANA system.FunctionMessage
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull FunctionMessageDeleteFluentHelper deleteFunctionMessage(@Nonnull FunctionMessage functionMessage)
FunctionMessage
entity in the S/4HANA system.functionMessage
- FunctionMessage
entity object that will be deleted in the S/4HANA system.FunctionMessage
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ProcessOrderFluentHelper getAllProcessOrder()
ProcessOrder
entities.ProcessOrder
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 ProcessOrderByKeyFluentHelper getProcessOrderByKey(String processOrder)
ProcessOrder
entity using key fields.processOrder
- Manufacturing Order ID
Constraints: Not nullable, Maximum length: 12
ProcessOrder
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 ProcessOrderCreateFluentHelper createProcessOrder(@Nonnull ProcessOrder processOrder)
ProcessOrder
entity and save it to the S/4HANA system.processOrder
- ProcessOrder
entity object that will be created in the S/4HANA system.ProcessOrder
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ProcessOrderUpdateFluentHelper updateProcessOrder(@Nonnull ProcessOrder processOrder)
ProcessOrder
entity and save it to the S/4HANA system.processOrder
- ProcessOrder
entity object that will be updated in the S/4HANA system.ProcessOrder
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ProcessOrderComponentFluentHelper getAllProcessOrderComponent()
ProcessOrderComponent
entities.ProcessOrderComponent
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 ProcessOrderComponentByKeyFluentHelper getProcessOrderComponentByKey(String reservation, String reservationItem)
ProcessOrderComponent
entity using key fields.reservationItem
- Reservation Item
Constraints: Not nullable, Maximum length: 4
reservation
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
ProcessOrderComponent
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 ProcessOrderItemFluentHelper getAllProcessOrderItem()
ProcessOrderItem
entities.ProcessOrderItem
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 ProcessOrderItemByKeyFluentHelper getProcessOrderItemByKey(String manufacturingOrder, String manufacturingOrderItem)
ProcessOrderItem
entity using key fields.manufacturingOrderItem
- Manufacturing Order Item ID
Constraints: Not nullable, Maximum length: 4
manufacturingOrder
- Manufacturing Order ID
Constraints: Not nullable, Maximum length: 12
ProcessOrderItem
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 ProcessOrderOperationFluentHelper getAllProcessOrderOperation()
ProcessOrderOperation
entities.ProcessOrderOperation
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 ProcessOrderOperationByKeyFluentHelper getProcessOrderOperationByKey(String orderInternalBillOfOperations, String orderIntBillOfOperationsItem)
ProcessOrderOperation
entity using key fields.orderIntBillOfOperationsItem
- Internal Identifier of an Operation or Activity
Constraints: Not nullable, Maximum length: 8
orderInternalBillOfOperations
- Order Internal ID
Constraints: Not nullable, Maximum length: 10
ProcessOrderOperation
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 ProcessOrderStatusFluentHelper getAllProcessOrderStatus()
ProcessOrderStatus
entities.ProcessOrderStatus
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 ProcessOrderStatusByKeyFluentHelper getProcessOrderStatusByKey(String manufacturingOrder, String statusCode)
ProcessOrderStatus
entity using key fields.manufacturingOrder
- Key that uniquely identifies an order within a client.
Constraints: Not nullable, Maximum length: 12
statusCode
- Key which informs you of the current status of an object.
Constraints: Not nullable, Maximum length: 5
ProcessOrderStatus
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 ReleaseOrderFluentHelper releaseOrder(String manufacturingOrder)
Creates a fluent helper for the ReleaseOrder OData function import.
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull ReleaseOperationFluentHelper releaseOperation(String manufacturingOrder, String manufacturingOrderOperation)
Creates a fluent helper for the ReleaseOperation OData function import.
manufacturingOrderOperation
- Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: ManufacturingOrderOperation
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull TechlyCmpltOrderFluentHelper techlyCmpltOrder(String manufacturingOrder)
Creates a fluent helper for the TechlyCmpltOrder OData function import.
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull CloseOrderFluentHelper closeOrder(String manufacturingOrder)
Creates a fluent helper for the CloseOrder OData function import.
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull DeletionFlagOrderFluentHelper deletionFlagOrder(String manufacturingOrder)
Creates a fluent helper for the DeletionFlagOrder OData function import.
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull DeletionIndOrderFluentHelper deletionIndOrder(String manufacturingOrder)
Creates a fluent helper for the DeletionIndOrder OData function import.
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull DiscardOrderFluentHelper discardOrder(String manufacturingOrder)
Creates a fluent helper for the DiscardOrder OData function import.
manufacturingOrder
- Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull ConvertPlndOrderFluentHelper convertPlndOrder(String plannedOrder, String manufacturingOrderType, String manufacturingOrder)
Creates a fluent helper for the ConvertPlndOrder OData function import.
plannedOrder
- Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: PlannedOrder
manufacturingOrderType
- Constraints: Nullable, Maximum length: 4
Original parameter name from the Odata EDM: ManufacturingOrderType
manufacturingOrder
- Constraints: Nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
execute
method on the fluent helper object.@Nonnull ScheduleProcessOrderOperationFluentHelper scheduleProcessOrderOperation(String manufacturingOrder, String orderInternalBillOfOperations, String orderIntBillOfOperationsItem, LocalDateTime opSchedldStartDate, LocalTime opSchedldStartTime, LocalDateTime opSchedldEndDate, LocalTime opSchedldEndTime, String opSchedulingMode, String opSchedulingStatus, String opSchedulingStrategy)
Creates a fluent helper for the ScheduleProcessOrderOperation OData function import.
orderIntBillOfOperationsItem
- Operation Internal ID
Constraints: Not nullable, Maximum length: 8
Original parameter name from the Odata EDM: OrderIntBillOfOperationsItem
opSchedldStartDate
- Execution Start Date
Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: OpSchedldStartDate
opSchedulingStrategy
- Component of the Version Number
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: OpSchedulingStrategy
orderInternalBillOfOperations
- Order Internal ID
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: OrderInternalBillOfOperations
opSchedulingStatus
- Status
Constraints: Nullable, Maximum length: 4
Original parameter name from the Odata EDM: OpSchedulingStatus
opSchedulingMode
- Scheduling type
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: OpSchedulingMode
manufacturingOrder
- Order
Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: ManufacturingOrder
opSchedldStartTime
- Execution Start Time
Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: OpSchedldStartTime
opSchedldEndDate
- Execution End Date
Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: OpSchedldEndDate
opSchedldEndTime
- Execution End Time
Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: OpSchedldEndTime
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.