public interface CommercialProjectService extends BatchService<CommercialProjectServiceBatch>
For example, you can use this service to create a customer or internal project based on an opportunity or a quotation in an external system. The service enables the following operations: - Create and update commercial projects - Update the stage of projects - Create and update work packages - Create and update the roles and effort needed to deliver the project - Delete work packages, roles, and work items - Create, read, and update sales orders for your projects.
Reference: SAP API Business Hub
OData Service: | _CPD_SC_PROJ_ENGMT_CREATE_UPD_SRV |
API Version: | 1 |
Communication Scenario: | Commercial Project Integration (SAP_COM_0054) |
Scope Items: | Internal Project Management - Project-Based Services (1A8), Customer Project Management - Project-Based Services (J11) |
Authentication Methods: | Basic, x509, OAuth2 |
Business Object: | CommercialProject |
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 CommercialProjectService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull CustProjSlsOrdFluentHelper getAllCustProjSlsOrd()
CustProjSlsOrd
entities.CustProjSlsOrd
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 CustProjSlsOrdByKeyFluentHelper getCustProjSlsOrdByKey(String customerProject)
CustProjSlsOrd
entity using key fields.customerProject
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
CustProjSlsOrd
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 CustProjSlsOrdCreateFluentHelper createCustProjSlsOrd(@Nonnull CustProjSlsOrd custProjSlsOrd)
CustProjSlsOrd
entity and save it to the S/4HANA system.custProjSlsOrd
- CustProjSlsOrd
entity object that will be created in the S/4HANA system.CustProjSlsOrd
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdUpdateFluentHelper updateCustProjSlsOrd(@Nonnull CustProjSlsOrd custProjSlsOrd)
CustProjSlsOrd
entity and save it to the S/4HANA system.custProjSlsOrd
- CustProjSlsOrd
entity object that will be updated in the S/4HANA system.CustProjSlsOrd
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdItemFluentHelper getAllCustProjSlsOrdItem()
CustProjSlsOrdItem
entities.CustProjSlsOrdItem
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 CustProjSlsOrdItemByKeyFluentHelper getCustProjSlsOrdItemByKey(String customerProject, String salesOrderItem)
CustProjSlsOrdItem
entity using key fields.salesOrderItem
- Sales Order Item
Constraints: Not nullable, Maximum length: 6
customerProject
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
CustProjSlsOrdItem
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 CustProjSlsOrdItemCreateFluentHelper createCustProjSlsOrdItem(@Nonnull CustProjSlsOrdItem custProjSlsOrdItem)
CustProjSlsOrdItem
entity and save it to the S/4HANA system.custProjSlsOrdItem
- CustProjSlsOrdItem
entity object that will be created in the S/4HANA system.CustProjSlsOrdItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdItemUpdateFluentHelper updateCustProjSlsOrdItem(@Nonnull CustProjSlsOrdItem custProjSlsOrdItem)
CustProjSlsOrdItem
entity and save it to the S/4HANA system.custProjSlsOrdItem
- CustProjSlsOrdItem
entity object that will be updated in the S/4HANA system.CustProjSlsOrdItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdItemDeleteFluentHelper deleteCustProjSlsOrdItem(@Nonnull CustProjSlsOrdItem custProjSlsOrdItem)
CustProjSlsOrdItem
entity in the S/4HANA system.custProjSlsOrdItem
- CustProjSlsOrdItem
entity object that will be deleted in the S/4HANA system.CustProjSlsOrdItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdItemTextFluentHelper getAllCustProjSlsOrdItemText()
CustProjSlsOrdItemText
entities.CustProjSlsOrdItemText
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 CustProjSlsOrdItemTextByKeyFluentHelper getCustProjSlsOrdItemTextByKey(String customerProject, String salesOrderItem, String language, String longTextID)
CustProjSlsOrdItemText
entity using key fields.salesOrderItem
- Sales Order Item
Constraints: Not nullable, Maximum length: 6
customerProject
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
longTextID
- The text ID defines the various types of texts related to a text object. For example, the object
"TEXT" (standard texts) can have the following text IDs:
Constraints: Not nullable, Maximum length: 4
CustProjSlsOrdItemText
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 CustProjSlsOrdItemTextCreateFluentHelper createCustProjSlsOrdItemText(@Nonnull CustProjSlsOrdItemText custProjSlsOrdItemText)
CustProjSlsOrdItemText
entity and save it to the S/4HANA system.custProjSlsOrdItemText
- CustProjSlsOrdItemText
entity object that will be created in the S/4HANA system.CustProjSlsOrdItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdItemTextUpdateFluentHelper updateCustProjSlsOrdItemText(@Nonnull CustProjSlsOrdItemText custProjSlsOrdItemText)
CustProjSlsOrdItemText
entity and save it to the S/4HANA system.custProjSlsOrdItemText
- CustProjSlsOrdItemText
entity object that will be updated in the S/4HANA system.CustProjSlsOrdItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdItemTextDeleteFluentHelper deleteCustProjSlsOrdItemText(@Nonnull CustProjSlsOrdItemText custProjSlsOrdItemText)
CustProjSlsOrdItemText
entity in the S/4HANA system.custProjSlsOrdItemText
- CustProjSlsOrdItemText
entity object that will be deleted in the S/4HANA system.CustProjSlsOrdItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdItemWorkPckgFluentHelper getAllCustProjSlsOrdItemWorkPckg()
CustProjSlsOrdItemWorkPckg
entities.CustProjSlsOrdItemWorkPckg
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 CustProjSlsOrdItemWorkPckgByKeyFluentHelper getCustProjSlsOrdItemWorkPckgByKey(String customerProject, String salesOrderItem, String workPackage)
CustProjSlsOrdItemWorkPckg
entity using key fields.salesOrderItem
- Sales Order Item
Constraints: Not nullable, Maximum length: 6
customerProject
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
workPackage
- Plan Item
Constraints: Not nullable, Maximum length: 50
CustProjSlsOrdItemWorkPckg
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 CustProjSlsOrdItmBillgPlnItmFluentHelper getAllCustProjSlsOrdItmBillgPlnItm()
CustProjSlsOrdItmBillgPlnItm
entities.CustProjSlsOrdItmBillgPlnItm
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 CustProjSlsOrdItmBillgPlnItmByKeyFluentHelper getCustProjSlsOrdItmBillgPlnItmByKey(String customerProject, String salesOrderItem, String billingPlanItem)
CustProjSlsOrdItmBillgPlnItm
entity using key fields.salesOrderItem
- Sales Order Item
Constraints: Not nullable, Maximum length: 6
customerProject
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
billingPlanItem
- Item for billing plan/invoice plan/payment cards
Constraints: Not nullable, Maximum length: 6
CustProjSlsOrdItmBillgPlnItm
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 CustProjSlsOrdItmBillgPlnItmCreateFluentHelper createCustProjSlsOrdItmBillgPlnItm(@Nonnull CustProjSlsOrdItmBillgPlnItm custProjSlsOrdItmBillgPlnItm)
CustProjSlsOrdItmBillgPlnItm
entity and save it to the S/4HANA system.custProjSlsOrdItmBillgPlnItm
- CustProjSlsOrdItmBillgPlnItm
entity object that will be created in the S/4HANA system.CustProjSlsOrdItmBillgPlnItm
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdItmBillgPlnItmUpdateFluentHelper updateCustProjSlsOrdItmBillgPlnItm(@Nonnull CustProjSlsOrdItmBillgPlnItm custProjSlsOrdItmBillgPlnItm)
CustProjSlsOrdItmBillgPlnItm
entity and save it to the S/4HANA system.custProjSlsOrdItmBillgPlnItm
- CustProjSlsOrdItmBillgPlnItm
entity object that will be updated in the S/4HANA system.CustProjSlsOrdItmBillgPlnItm
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdItmBillgPlnItmDeleteFluentHelper deleteCustProjSlsOrdItmBillgPlnItm(@Nonnull CustProjSlsOrdItmBillgPlnItm custProjSlsOrdItmBillgPlnItm)
CustProjSlsOrdItmBillgPlnItm
entity in the S/4HANA system.custProjSlsOrdItmBillgPlnItm
- CustProjSlsOrdItmBillgPlnItm
entity object that will be deleted in the S/4HANA system.CustProjSlsOrdItmBillgPlnItm
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdPartnerFluentHelper getAllCustProjSlsOrdPartner()
CustProjSlsOrdPartner
entities.CustProjSlsOrdPartner
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 CustProjSlsOrdPartnerByKeyFluentHelper getCustProjSlsOrdPartnerByKey(String customerProject, String partnerFunction)
CustProjSlsOrdPartner
entity using key fields.partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
customerProject
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
CustProjSlsOrdPartner
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 CustProjSlsOrdPartnerCreateFluentHelper createCustProjSlsOrdPartner(@Nonnull CustProjSlsOrdPartner custProjSlsOrdPartner)
CustProjSlsOrdPartner
entity and save it to the S/4HANA system.custProjSlsOrdPartner
- CustProjSlsOrdPartner
entity object that will be created in the S/4HANA system.CustProjSlsOrdPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdPartnerUpdateFluentHelper updateCustProjSlsOrdPartner(@Nonnull CustProjSlsOrdPartner custProjSlsOrdPartner)
CustProjSlsOrdPartner
entity and save it to the S/4HANA system.custProjSlsOrdPartner
- CustProjSlsOrdPartner
entity object that will be updated in the S/4HANA system.CustProjSlsOrdPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdTextFluentHelper getAllCustProjSlsOrdText()
CustProjSlsOrdText
entities.CustProjSlsOrdText
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 CustProjSlsOrdTextByKeyFluentHelper getCustProjSlsOrdTextByKey(String customerProject, String language, String longTextID)
CustProjSlsOrdText
entity using key fields.customerProject
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
longTextID
- The text ID defines the various types of texts related to a text object. For example, the object
"TEXT" (standard texts) can have the following text IDs:
Constraints: Not nullable, Maximum length: 4
CustProjSlsOrdText
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 CustProjSlsOrdTextCreateFluentHelper createCustProjSlsOrdText(@Nonnull CustProjSlsOrdText custProjSlsOrdText)
CustProjSlsOrdText
entity and save it to the S/4HANA system.custProjSlsOrdText
- CustProjSlsOrdText
entity object that will be created in the S/4HANA system.CustProjSlsOrdText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdTextUpdateFluentHelper updateCustProjSlsOrdText(@Nonnull CustProjSlsOrdText custProjSlsOrdText)
CustProjSlsOrdText
entity and save it to the S/4HANA system.custProjSlsOrdText
- CustProjSlsOrdText
entity object that will be updated in the S/4HANA system.CustProjSlsOrdText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustProjSlsOrdTextDeleteFluentHelper deleteCustProjSlsOrdText(@Nonnull CustProjSlsOrdText custProjSlsOrdText)
CustProjSlsOrdText
entity in the S/4HANA system.custProjSlsOrdText
- CustProjSlsOrdText
entity object that will be deleted in the S/4HANA system.CustProjSlsOrdText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ProjectFluentHelper getAllProject()
Project
entities.@Nonnull ProjectByKeyFluentHelper getProjectByKey(String projectID)
Project
entity using key fields.projectID
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
Project
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 ProjectCreateFluentHelper createProject(@Nonnull Project project)
Project
entity
and save it to the S/4HANA system.@Nonnull ProjectUpdateFluentHelper updateProject(@Nonnull Project project)
Project
entity and save it to the S/4HANA system.@Nonnull WorkPackageFluentHelper getAllWorkPackage()
WorkPackage
entities.WorkPackage
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 WorkPackageByKeyFluentHelper getWorkPackageByKey(String projectID, String workPackageID, String workPackageName)
WorkPackage
entity using key fields.workPackageID
- Plan Item
Constraints: Not nullable, Maximum length: 50
workPackageName
- Plan Item Description
Constraints: Not nullable, Maximum length: 60
projectID
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
WorkPackage
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 WorkPackageCreateFluentHelper createWorkPackage(@Nonnull WorkPackage workPackage)
WorkPackage
entity and save it to the S/4HANA system.workPackage
- WorkPackage
entity object that will be created in the S/4HANA system.WorkPackage
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull WorkPackageUpdateFluentHelper updateWorkPackage(@Nonnull WorkPackage workPackage)
WorkPackage
entity and save it to the S/4HANA system.workPackage
- WorkPackage
entity object that will be updated in the S/4HANA system.WorkPackage
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull WorkPackageDeleteFluentHelper deleteWorkPackage(@Nonnull WorkPackage workPackage)
WorkPackage
entity in the S/4HANA system.workPackage
- WorkPackage
entity object that will be deleted in the S/4HANA system.WorkPackage
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull WorkItemFluentHelper getAllWorkItem()
WorkItem
entities.@Nonnull WorkItemByKeyFluentHelper getWorkItemByKey(String projectID, String workitem, String workPackageID, String workPackageName)
WorkItem
entity using key fields.workPackageID
- Plan Item
Constraints: Not nullable, Maximum length: 50
workPackageName
- Plan Item Description
Constraints: Not nullable, Maximum length: 60
workitem
- Work Item ID
Constraints: Not nullable, Maximum length: 10
projectID
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
WorkItem
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 WorkItemCreateFluentHelper createWorkItem(@Nonnull WorkItem workItem)
WorkItem
entity and save it to the S/4HANA system.@Nonnull WorkItemUpdateFluentHelper updateWorkItem(@Nonnull WorkItem workItem)
WorkItem
entity and save it to the S/4HANA system.@Nonnull WorkItemDeleteFluentHelper deleteWorkItem(@Nonnull WorkItem workItem)
WorkItem
entity in the S/4HANA system.@Nonnull DemandFluentHelper getAllDemand()
Demand
entities.@Nonnull DemandByKeyFluentHelper getDemandByKey(String projectID, String workPackageID, String workPackageName, String resType, String resourceId, String workitem, String delvryServOrg)
Demand
entity
using key fields.delvryServOrg
- This field links master project data with the company code and plant.
Constraints: Not nullable, Maximum length: 5
resourceId
- Used to uniquely identify a resource.
Constraints: Not nullable, Maximum length: 40
workPackageID
- Plan Item
Constraints: Not nullable, Maximum length: 50
workPackageName
- Plan Item Description
Constraints: Not nullable, Maximum length: 60
resType
- Used to uniquely identify the resource type.
Constraints: Not nullable, Maximum length: 4
workitem
- Work Item ID
Constraints: Not nullable, Maximum length: 10
projectID
- Identifies a master project.
Constraints: Not nullable, Maximum length: 40
Demand
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 DemandCreateFluentHelper createDemand(@Nonnull Demand demand)
Demand
entity
and save it to the S/4HANA system.@Nonnull DemandUpdateFluentHelper updateDemand(@Nonnull Demand demand)
Demand
entity and save it to the S/4HANA system.@Nonnull DemandDeleteFluentHelper deleteDemand(@Nonnull Demand demand)
Demand
entity in the S/4HANA system.Copyright © 2020 SAP SE. All rights reserved.