com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface ProductionOrderConfirmationV2Service

All Superinterfaces:

BatchService<ProductionOrderConfirmationV2ServiceBatch>

All Known Implementing Classes:

DefaultProductionOrderConfirmationV2Service

public interface ProductionOrderConfirmationV2Service
extends BatchService<ProductionOrderConfirmationV2ServiceBatch>

You can create time ticket and time event confirmations as well as confirmations on order level, read them, and cancel the confirmations on time ticket, time event, or order level. Before creating a time ticket confirmation, you can fetch the proposed data for quantities, work activities, dates and times, personnel data, and goods movements.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PROD_ORDER_CONFIRMATION_2_SRV
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
Business Object:	ProductionOrderConfirmation

Field Summary

Fields

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.

Method Summary

Modifier and Type	Method and Description
CancelProdnOrdConfFluentHelper	cancelProdnOrdConf(String confirmationGroup, String confirmationCount, LocalDateTime postingDate, String confirmationText, UUID externalSystemConfirmation) Creates a fluent helper for the CancelProdnOrdConf OData function import.
ProdnOrdConf2CreateFluentHelper	createProdnOrdConf2(ProdnOrdConf2 prodnOrdConf2) Create a new ProdnOrdConf2 entity and save it to the S/4HANA system.
ProdnOrdConf2FluentHelper	getAllProdnOrdConf2() Fetch multiple ProdnOrdConf2 entities.
ProdnOrdConfMatlDocItmFluentHelper	getAllProdnOrdConfMatlDocItm() Fetch multiple ProdnOrdConfMatlDocItm entities.
GetConfProposalFluentHelper	getConfProposal(String confirmationGroup, String orderID, String orderOperation, String sequence, String orderSuboperation, String orderConfirmationRecordType, String confirmationUnit, String confirmationUnitISOCode, BigDecimal confirmationYieldQuantity, BigDecimal confirmationScrapQuantity, BigDecimal confirmationReworkQuantity, Boolean quantityIsToBeProposed, Boolean activityIsToBeProposed, Boolean dateAndTimeIsToBeProposed, Boolean personnelIsToBeProposed) Creates a fluent helper for the GetConfProposal OData function import.
GetGdsMvtProposalFluentHelper	getGdsMvtProposal(String confirmationGroup, String orderID, String orderOperation, String sequence, String orderSuboperation, String orderConfirmationRecordType, String confirmationUnit, String confirmationUnitISOCode, BigDecimal confirmationYieldQuantity, BigDecimal confirmationScrapQuantity, BigDecimal confirmationReworkQuantity, Boolean quantityIsToBeProposed, Boolean activityIsToBeProposed, Boolean dateAndTimeIsToBeProposed, Boolean personnelIsToBeProposed) Creates a fluent helper for the GetGdsMvtProposal OData function import.
ProdnOrdConf2ByKeyFluentHelper	getProdnOrdConf2ByKey(String confirmationGroup, String confirmationCount) Fetch a single ProdnOrdConf2 entity using key fields.
ProdnOrdConfMatlDocItmByKeyFluentHelper	getProdnOrdConfMatlDocItmByKey(String confirmationGroup, String confirmationCount, String materialDocument, String materialDocumentItem, String materialDocumentYear) Fetch a single ProdnOrdConfMatlDocItm entity using key fields.
ProductionOrderConfirmationV2Service	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final 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.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
ProductionOrderConfirmationV2Service withServicePath(@Nonnull
                                                              String servicePath)

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.

getAllProdnOrdConfMatlDocItm

@Nonnull
ProdnOrdConfMatlDocItmFluentHelper getAllProdnOrdConfMatlDocItm()

Fetch multiple ProdnOrdConfMatlDocItm entities.

Returns:

A fluent helper to fetch multiple ProdnOrdConfMatlDocItm 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.

getProdnOrdConfMatlDocItmByKey

@Nonnull
ProdnOrdConfMatlDocItmByKeyFluentHelper getProdnOrdConfMatlDocItmByKey(String confirmationGroup,
                                                                                String confirmationCount,
                                                                                String materialDocument,
                                                                                String materialDocumentItem,
                                                                                String materialDocumentYear)

Fetch a single ProdnOrdConfMatlDocItm entity using key fields.

Parameters:

materialDocument - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

confirmationCount - Identifier of Single Order Confirmation

Constraints: Not nullable, Maximum length: 8

materialDocumentItem - Specifies the number that uniquely identifies an item in .

Constraints: Not nullable, Maximum length: 4

materialDocumentYear - Calendar year in which the material document was posted.

Constraints: Not nullable, Maximum length: 4

confirmationGroup - Collective ID of Order Confirmations

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single ProdnOrdConfMatlDocItm 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.

getAllProdnOrdConf2

@Nonnull
ProdnOrdConf2FluentHelper getAllProdnOrdConf2()

Fetch multiple ProdnOrdConf2 entities.

Returns:

A fluent helper to fetch multiple ProdnOrdConf2 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.

getProdnOrdConf2ByKey

@Nonnull
ProdnOrdConf2ByKeyFluentHelper getProdnOrdConf2ByKey(String confirmationGroup,
                                                              String confirmationCount)

Fetch a single ProdnOrdConf2 entity using key fields.

Parameters:

confirmationCount - Identifier of Single Order Confirmation

Constraints: Not nullable, Maximum length: 8

confirmationGroup - Collective ID of Order Confirmations

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single ProdnOrdConf2 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.

createProdnOrdConf2

@Nonnull
ProdnOrdConf2CreateFluentHelper createProdnOrdConf2(@Nonnull
                                                             ProdnOrdConf2 prodnOrdConf2)

Create a new ProdnOrdConf2 entity and save it to the S/4HANA system.

Parameters:

prodnOrdConf2 - ProdnOrdConf2 entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ProdnOrdConf2 entity. To perform execution, call the execute method on the fluent helper object.

cancelProdnOrdConf

@Nonnull
CancelProdnOrdConfFluentHelper cancelProdnOrdConf(String confirmationGroup,
                                                           String confirmationCount,
                                                           LocalDateTime postingDate,
                                                           String confirmationText,
                                                           UUID externalSystemConfirmation)

Creates a fluent helper for the CancelProdnOrdConf OData function import.

Parameters:

externalSystemConfirmation - External Key

Constraints: Nullable

Original parameter name from the Odata EDM: ExternalSystemConfirmation

confirmationCount - Order Confirmation

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: ConfirmationCount

confirmationText - Confirmation Text

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: ConfirmationText

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

confirmationGroup - Confirmation Group

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: ConfirmationGroup

Returns:

A fluent helper object that will execute the CancelProdnOrdConf OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

getConfProposal

@Nonnull
GetConfProposalFluentHelper getConfProposal(String confirmationGroup,
                                                     String orderID,
                                                     String orderOperation,
                                                     String sequence,
                                                     String orderSuboperation,
                                                     String orderConfirmationRecordType,
                                                     String confirmationUnit,
                                                     String confirmationUnitISOCode,
                                                     BigDecimal confirmationYieldQuantity,
                                                     BigDecimal confirmationScrapQuantity,
                                                     BigDecimal confirmationReworkQuantity,
                                                     Boolean quantityIsToBeProposed,
                                                     Boolean activityIsToBeProposed,
                                                     Boolean dateAndTimeIsToBeProposed,
                                                     Boolean personnelIsToBeProposed)

Creates a fluent helper for the GetConfProposal OData function import.

Parameters:

dateAndTimeIsToBeProposed - Propose Dates

Constraints: Nullable

Original parameter name from the Odata EDM: DateAndTimeIsToBeProposed

orderID - Manufacturing Order

Constraints: Nullable, Maximum length: 12

Original parameter name from the Odata EDM: OrderID

confirmationUnitISOCode - ISO code

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: ConfirmationUnitISOCode

confirmationGroup - Confirmation Group

Constraints: Nullable, Maximum length: 10

Original parameter name from the Odata EDM: ConfirmationGroup

confirmationYieldQuantity - Yield Quantity

Constraints: Nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: ConfirmationYieldQuantity

quantityIsToBeProposed - Propose Quantities

Constraints: Nullable

Original parameter name from the Odata EDM: QuantityIsToBeProposed

sequence - Sequence

Constraints: Nullable, Maximum length: 6

Original parameter name from the Odata EDM: Sequence

orderConfirmationRecordType - Record Type

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: OrderConfirmationRecordType

confirmationUnit - Display Unit/Measure

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: ConfirmationUnit

orderSuboperation - Suboperation

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: OrderSuboperation

personnelIsToBeProposed - Propose Personnel

Constraints: Nullable

Original parameter name from the Odata EDM: PersonnelIsToBeProposed

confirmationReworkQuantity - Rework Quantity

Constraints: Nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: ConfirmationReworkQuantity

activityIsToBeProposed - Propose Activities

Constraints: Nullable

Original parameter name from the Odata EDM: ActivityIsToBeProposed

orderOperation - Operation

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: OrderOperation

confirmationScrapQuantity - Scrap Quantity

Constraints: Nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: ConfirmationScrapQuantity

Returns:

A fluent helper object that will execute the GetConfProposal OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

getGdsMvtProposal

@Nonnull
GetGdsMvtProposalFluentHelper getGdsMvtProposal(String confirmationGroup,
                                                         String orderID,
                                                         String orderOperation,
                                                         String sequence,
                                                         String orderSuboperation,
                                                         String orderConfirmationRecordType,
                                                         String confirmationUnit,
                                                         String confirmationUnitISOCode,
                                                         BigDecimal confirmationYieldQuantity,
                                                         BigDecimal confirmationScrapQuantity,
                                                         BigDecimal confirmationReworkQuantity,
                                                         Boolean quantityIsToBeProposed,
                                                         Boolean activityIsToBeProposed,
                                                         Boolean dateAndTimeIsToBeProposed,
                                                         Boolean personnelIsToBeProposed)

Creates a fluent helper for the GetGdsMvtProposal OData function import.

Parameters:

dateAndTimeIsToBeProposed - Propose Dates

Constraints: Nullable

Original parameter name from the Odata EDM: DateAndTimeIsToBeProposed

orderID - Manufacturing Order

Constraints: Nullable, Maximum length: 12

Original parameter name from the Odata EDM: OrderID

confirmationUnitISOCode - ISO code

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: ConfirmationUnitISOCode

confirmationGroup - Confirmation Group

Constraints: Nullable, Maximum length: 10

Original parameter name from the Odata EDM: ConfirmationGroup

confirmationYieldQuantity - Yield Quantity

Constraints: Nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: ConfirmationYieldQuantity

quantityIsToBeProposed - Propose Quantities

Constraints: Nullable

Original parameter name from the Odata EDM: QuantityIsToBeProposed

sequence - Sequence

Constraints: Nullable, Maximum length: 6

Original parameter name from the Odata EDM: Sequence

orderConfirmationRecordType - Record Type

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: OrderConfirmationRecordType

confirmationUnit - Display Unit/Measure

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: ConfirmationUnit

orderSuboperation - Suboperation

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: OrderSuboperation

personnelIsToBeProposed - Propose Personnel

Constraints: Nullable

Original parameter name from the Odata EDM: PersonnelIsToBeProposed

confirmationReworkQuantity - Rework Quantity

Constraints: Nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: ConfirmationReworkQuantity

activityIsToBeProposed - Propose Activities

Constraints: Nullable

Original parameter name from the Odata EDM: ActivityIsToBeProposed

orderOperation - Operation

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: OrderOperation

confirmationScrapQuantity - Scrap Quantity

Constraints: Nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: ConfirmationScrapQuantity

Returns:

A fluent helper object that will execute the GetGdsMvtProposal OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.