Interface PlannedOrderService
- All Known Implementing Classes:
DefaultPlannedOrderService
The service contains planned order header, planned order capacity and planned order components. The information is sent in the request as a payload. You can read, create, change and delete components of orders and also use this service to schedule planned order operations..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | PLANNEDORDER_0001 |
| API Version: | 1.0.3 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Production Planning Integration(SAP_COM_0104) |
| Scope Items: | Make-to-Stock Production - Discrete Manufacturing(BJ5), Make-to-Stock - Process Manufacturing Based on Process Order(BJ8), Material Requirements Planning(J44), Material Requirements Planning(O44) |
| Authentication Methods: | x509 |
| Service Group Name: | API_PLANNEDORDER |
| Business Object: | Planned Order |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from thePlannedOrderCapacityentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from thePlannedOrderComponententity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from thePlannedOrderHeaderentity collection matching the filter and search expressions.createPlannedOrderCapacity(PlannedOrderCapacity plannedOrderCapacity) Deprecated.Create a newPlannedOrderCapacityentity and save it to the S/4HANA system.createPlannedOrderHeader(PlannedOrderHeader plannedOrderHeader) Deprecated.Create a newPlannedOrderHeaderentity and save it to the S/4HANA system.deletePlannedOrderComponent(PlannedOrderComponent plannedOrderComponent) Deprecated.Deletes an existingPlannedOrderComponententity in the S/4HANA system.deletePlannedOrderHeader(PlannedOrderHeader plannedOrderHeader) Deprecated.Deletes an existingPlannedOrderHeaderentity in the S/4HANA system.Deprecated.Fetch multiplePlannedOrderCapacityentities.Deprecated.Fetch multiplePlannedOrderComponententities.Deprecated.Fetch multiplePlannedOrderHeaderentities.getPlannedOrderCapacityByKey(String plannedOrder, String capacityRequirement, String capacityRequirementItem, String capacityRqmtItemCapacity) Deprecated.Fetch a singlePlannedOrderCapacityentity using key fields.getPlannedOrderComponentByKey(String plannedOrder, String reservation, String reservationItem) Deprecated.Fetch a singlePlannedOrderComponententity using key fields.getPlannedOrderHeaderByKey(String plannedOrder) Deprecated.Fetch a singlePlannedOrderHeaderentity using key fields.updatePlannedOrderComponent(PlannedOrderComponent plannedOrderComponent) Deprecated.Update an existingPlannedOrderComponententity and save it to the S/4HANA system.updatePlannedOrderHeader(PlannedOrderHeader plannedOrderHeader) Deprecated.Update an existingPlannedOrderHeaderentity and save it to the S/4HANA system.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
Deprecated.Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Parameters:
servicePath- Service path that will override the default.- Returns:
- A new service instance with the specified service path.
-
batch
Deprecated.Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllPlannedOrderCapacity
Deprecated.Fetch multiplePlannedOrderCapacityentities.- Returns:
- A request builder to fetch multiple
PlannedOrderCapacityentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countPlannedOrderCapacity
Deprecated.Fetch the number of entries from thePlannedOrderCapacityentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
PlannedOrderCapacityentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getPlannedOrderCapacityByKey
@Nonnull GetByKeyRequestBuilder<PlannedOrderCapacity> getPlannedOrderCapacityByKey(String plannedOrder, String capacityRequirement, String capacityRequirementItem, String capacityRqmtItemCapacity) Deprecated.Fetch a singlePlannedOrderCapacityentity using key fields.- Parameters:
capacityRequirementItem- Capacity Requirement ItemConstraints: Not nullable, Maximum length: 8
capacityRequirement- ID of the Capacity Requirements RecordConstraints: Not nullable, Maximum length: 12
plannedOrder- Planned OrderConstraints: Not nullable, Maximum length: 10
capacityRqmtItemCapacity- Individual Capacity of a Capacity Requirement ItemConstraints: Not nullable, Maximum length: 4
- Returns:
- A request builder to fetch a single
PlannedOrderCapacityentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
createPlannedOrderCapacity
@Nonnull CreateRequestBuilder<PlannedOrderCapacity> createPlannedOrderCapacity(@Nonnull PlannedOrderCapacity plannedOrderCapacity) Deprecated.Create a newPlannedOrderCapacityentity and save it to the S/4HANA system.- Parameters:
plannedOrderCapacity-PlannedOrderCapacityentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
PlannedOrderCapacityentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllPlannedOrderComponent
Deprecated.Fetch multiplePlannedOrderComponententities.- Returns:
- A request builder to fetch multiple
PlannedOrderComponententities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countPlannedOrderComponent
Deprecated.Fetch the number of entries from thePlannedOrderComponententity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
PlannedOrderComponententities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getPlannedOrderComponentByKey
@Nonnull GetByKeyRequestBuilder<PlannedOrderComponent> getPlannedOrderComponentByKey(String plannedOrder, String reservation, String reservationItem) Deprecated.Fetch a singlePlannedOrderComponententity using key fields.- Parameters:
plannedOrder- Planned OrderConstraints: Not nullable, Maximum length: 10
reservationItem- Reservation ItemConstraints: Not nullable, Maximum length: 4
reservation- Number of reservation/dependent requirementsConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
PlannedOrderComponententity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
updatePlannedOrderComponent
@Nonnull UpdateRequestBuilder<PlannedOrderComponent> updatePlannedOrderComponent(@Nonnull PlannedOrderComponent plannedOrderComponent) Deprecated.Update an existingPlannedOrderComponententity and save it to the S/4HANA system.- Parameters:
plannedOrderComponent-PlannedOrderComponententity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
PlannedOrderComponententity. To perform execution, call theexecutemethod on the request builder object.
-
deletePlannedOrderComponent
@Nonnull DeleteRequestBuilder<PlannedOrderComponent> deletePlannedOrderComponent(@Nonnull PlannedOrderComponent plannedOrderComponent) Deprecated.Deletes an existingPlannedOrderComponententity in the S/4HANA system.- Parameters:
plannedOrderComponent-PlannedOrderComponententity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
PlannedOrderComponententity. To perform execution, call theexecutemethod on the request builder object.
-
getAllPlannedOrderHeader
Deprecated.Fetch multiplePlannedOrderHeaderentities.- Returns:
- A request builder to fetch multiple
PlannedOrderHeaderentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countPlannedOrderHeader
Deprecated.Fetch the number of entries from thePlannedOrderHeaderentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
PlannedOrderHeaderentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getPlannedOrderHeaderByKey
Deprecated.Fetch a singlePlannedOrderHeaderentity using key fields.- Parameters:
plannedOrder- Planned OrderConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
PlannedOrderHeaderentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
createPlannedOrderHeader
@Nonnull CreateRequestBuilder<PlannedOrderHeader> createPlannedOrderHeader(@Nonnull PlannedOrderHeader plannedOrderHeader) Deprecated.Create a newPlannedOrderHeaderentity and save it to the S/4HANA system.- Parameters:
plannedOrderHeader-PlannedOrderHeaderentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
PlannedOrderHeaderentity. To perform execution, call theexecutemethod on the request builder object.
-
updatePlannedOrderHeader
@Nonnull UpdateRequestBuilder<PlannedOrderHeader> updatePlannedOrderHeader(@Nonnull PlannedOrderHeader plannedOrderHeader) Deprecated.Update an existingPlannedOrderHeaderentity and save it to the S/4HANA system.- Parameters:
plannedOrderHeader-PlannedOrderHeaderentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
PlannedOrderHeaderentity. To perform execution, call theexecutemethod on the request builder object.
-
deletePlannedOrderHeader
@Nonnull DeleteRequestBuilder<PlannedOrderHeader> deletePlannedOrderHeader(@Nonnull PlannedOrderHeader plannedOrderHeader) Deprecated.Deletes an existingPlannedOrderHeaderentity in the S/4HANA system.- Parameters:
plannedOrderHeader-PlannedOrderHeaderentity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
PlannedOrderHeaderentity. To perform execution, call theexecutemethod on the request builder object.
-