public interface KanbanControlCycleV2Service extends BatchService<KanbanControlCycleV2ServiceBatch>
The kanban OData API enables you to create and retrieve kanban control cycles and their kanban container data. Additionally, it is possible to change control cycles, to set the status both on control cycle and on container level, and to lock/unlock containers. Furthermore, you can add new containers for event-driven kanban control cycles and you can report the withdrawal out of one or more containers. The service is based on the OData protocol and can be consumed by external systems and user interfaces..
Reference: SAP API Business Hub
OData Service: | API_KANBAN_CONTROL_CYCLE_SRV_0002 |
API Version: | 2 |
Communication Scenario: | Kanban Control Cycle Integration (SAP_COM_0330) |
Scope Items: | Material Replenishment with Kanban – External Procurement (1E3), Material Replenishment with Kanban - In-House Production (4B3), Material Replenishment with Kanban - Stock Transfer (4B4) |
Authentication Methods: | Basic, x509, OAuth2 |
Business Object: | KanbanControlCycle |
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. |
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull KanbanControlCycleV2Service withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull KanbanContainerFluentHelper getAllKanbanContainer()
KanbanContainer
entities.KanbanContainer
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 KanbanContainerByKeyFluentHelper getKanbanContainerByKey(String kanbanContainer)
KanbanContainer
entity using key fields.kanbanContainer
- Kanban Container
Constraints: Not nullable, Maximum length: 10
KanbanContainer
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 KanbanContainerDeliveryAddrFluentHelper getAllKanbanContainerDeliveryAddr()
KanbanContainerDeliveryAddr
entities.KanbanContainerDeliveryAddr
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 KanbanContainerDeliveryAddrByKeyFluentHelper getKanbanContainerDeliveryAddrByKey(String kanbanControlCycle)
KanbanContainerDeliveryAddr
entity using key fields.kanbanControlCycle
- Kanban Control Cycle
Constraints: Not nullable, Maximum length: 7
KanbanContainerDeliveryAddr
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 KanbanControlCycleFluentHelper getAllKanbanControlCycle()
KanbanControlCycle
entities.KanbanControlCycle
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 KanbanControlCycleByKeyFluentHelper getKanbanControlCycleByKey(String kanbanControlCycle)
KanbanControlCycle
entity using key fields.kanbanControlCycle
- Kanban Control Cycle
Constraints: Not nullable, Maximum length: 7
KanbanControlCycle
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 KanbanControlCycleCreateFluentHelper createKanbanControlCycle(@Nonnull KanbanControlCycle kanbanControlCycle)
KanbanControlCycle
entity and save it to the S/4HANA system.kanbanControlCycle
- KanbanControlCycle
entity object that will be created in the S/4HANA system.KanbanControlCycle
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull KanbanControlCycleUpdateFluentHelper updateKanbanControlCycle(@Nonnull KanbanControlCycle kanbanControlCycle)
KanbanControlCycle
entity and save it to the S/4HANA system.kanbanControlCycle
- KanbanControlCycle
entity object that will be updated in the S/4HANA system.KanbanControlCycle
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull KanbanControlCycleDeleteFluentHelper deleteKanbanControlCycle(@Nonnull KanbanControlCycle kanbanControlCycle)
KanbanControlCycle
entity in the S/4HANA system.kanbanControlCycle
- KanbanControlCycle
entity object that will be deleted in the S/4HANA system.KanbanControlCycle
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull KanbanCtnDetailedQtyFluentHelper getAllKanbanCtnDetailedQty()
KanbanCtnDetailedQty
entities.KanbanCtnDetailedQty
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 KanbanCtnDetailedQtyByKeyFluentHelper getKanbanCtnDetailedQtyByKey(String kanbanContainer, String batch)
KanbanCtnDetailedQty
entity using key fields.batch
- Assigns a material that is manufactured in batches or production lots to a specific batch.
Constraints: Not nullable, Maximum length: 10
kanbanContainer
- Determines the Kanban number.
Constraints: Not nullable, Maximum length: 10
KanbanCtnDetailedQty
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 KanbanDeliveryFluentHelper getAllKanbanDelivery()
KanbanDelivery
entities.KanbanDelivery
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 KanbanDeliveryByKeyFluentHelper getKanbanDeliveryByKey(String kanbanContainer)
KanbanDelivery
entity using key fields.kanbanContainer
- Determines the Kanban number.
Constraints: Not nullable, Maximum length: 10
KanbanDelivery
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 SetKanbanContainerStatusFluentHelper setKanbanContainerStatus(String kanbanContainer, String kanbanContainerStatus, BigDecimal actualQuantityInUnitOfEntry, String unitOfEntry, String batch, ZonedDateTime kanbanCtnStatusChangeDateTime, String deliveryNote)
Creates a fluent helper for the SetKanbanContainerStatus OData function import.
actualQuantityInUnitOfEntry
- Constraints: Nullable, Precision: 13, Scale: 0
Original parameter name from the Odata EDM: ActualQuantityInUnitOfEntry
deliveryNote
- Constraints: Nullable
Original parameter name from the Odata EDM: DeliveryNote
kanbanContainerStatus
- Kanban Status
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: KanbanContainerStatus
batch
- Constraints: Nullable
Original parameter name from the Odata EDM: Batch
kanbanCtnStatusChangeDateTime
- Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: KanbanCtnStatusChangeDateTime
kanbanContainer
- Kanban ID
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: KanbanContainer
unitOfEntry
- Constraints: Nullable
Original parameter name from the Odata EDM: UnitOfEntry
execute
method on the fluent helper object.@Nonnull SetKanbanContainerLockFluentHelper setKanbanContainerLock(String kanbanContainer, Boolean isLocked)
Creates a fluent helper for the SetKanbanContainerLock OData function import.
isLocked
- Kanban is Blocked
Constraints: none
Original parameter name from the Odata EDM: IsLocked
kanbanContainer
- Kanban ID
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: KanbanContainer
execute
method on the fluent helper object.@Nonnull SetKanbanControlCycleLifeCycleStatusFluentHelper setKanbanControlCycleLifeCycleStatus(String kanbanControlCycle, String kanbanCtrlCycleLifeCycleStatus)
Creates a fluent helper for the SetKanbanControlCycleLifeCycleStatus OData function import.
kanbanCtrlCycleLifeCycleStatus
- Lifecycle Status
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: KanbanCtrlCycleLifeCycleStatus
kanbanControlCycle
- Control Cycle
Constraints: Not nullable, Maximum length: 7
Original parameter name from the Odata EDM: KanbanControlCycle
execute
method on the fluent helper object.@Nonnull AddEventDrivenKanbanContainerFluentHelper addEventDrivenKanbanContainer(String kanbanControlCycle, BigDecimal requestedQuantityInBaseUnit, ZonedDateTime requestedDeliveryDateTime, String packingInstruction, Short numberOfLoadCarriers)
Creates a fluent helper for the AddEventDrivenKanbanContainer OData function import.
requestedDeliveryDateTime
- Time Stamp
Constraints: Nullable, Precision: 7
Original parameter name from the Odata EDM: RequestedDeliveryDateTime
numberOfLoadCarriers
- No.Load Carriers
Constraints: Nullable
Original parameter name from the Odata EDM: NumberOfLoadCarriers
packingInstruction
- Packing instruction
Constraints: Nullable, Maximum length: 20
Original parameter name from the Odata EDM: PackingInstruction
requestedQuantityInBaseUnit
- Requested Quantity
Constraints: Nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: RequestedQuantityInBaseUnit
kanbanControlCycle
- Control Cycle
Constraints: Not nullable, Maximum length: 7
Original parameter name from the Odata EDM: KanbanControlCycle
execute
method on the fluent helper object.@Nonnull WithdrawQuantityFromControlCycleFluentHelper withdrawQuantityFromControlCycle(String kanbanControlCycle, BigDecimal kanbanCtrlCycWthdrwlQtyInBsUnt)
Creates a fluent helper for the WithdrawQuantityFromControlCycle OData function import.
kanbanCtrlCycWthdrwlQtyInBsUnt
- Withdrawal quantity
Constraints: Not nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: KanbanCtrlCycWthdrwlQtyInBsUnt
kanbanControlCycle
- Control Cycle
Constraints: Not nullable, Maximum length: 7
Original parameter name from the Odata EDM: KanbanControlCycle
execute
method on the fluent helper object.@Nonnull WithdrawQuantityFromKanbanContainerFluentHelper withdrawQuantityFromKanbanContainer(String kanbanContainer, BigDecimal kanbanCtnWithdrawalQtyInBsUnt)
Creates a fluent helper for the WithdrawQuantityFromKanbanContainer OData function import.
kanbanCtnWithdrawalQtyInBsUnt
- Withdrawal quantity
Constraints: Not nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: KanbanCtnWithdrawalQtyInBsUnt
kanbanContainer
- Kanban ID
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: KanbanContainer
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.