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

Interface CommercialProjectDetailService

All Known Implementing Classes:

DefaultCommercialProjectDetailService

public interface CommercialProjectDetailService

You can use this service to extract information related to customer or internal projects, created in your SAP S/4HANA Cloud. The service is designed to provide all header and detail-level information about a project, and can be used as a data provider for integration with third-party tools or applications that support activities such as resource management, staffing, or time recording.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	_CPD_SC_EXTERNAL_SERVICES_SRV
API Version:	1
Communication Scenario:	Commercial Project Integration (SAP_COM_0054)
Scope Items:	Internal Project Management (1A8), Customer Project Management (J11)

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
PlanDataFluentHelper	getAllPlanData() Fetch multiple PlanData entities.
ProjectFluentHelper	getAllProject() Fetch multiple Project entities.
StaffingDataFluentHelper	getAllStaffingData() Fetch multiple StaffingData entities.
WorkItemFluentHelper	getAllWorkItem() Fetch multiple WorkItem entities.
WorkpackageFluentHelper	getAllWorkpackage() Fetch multiple Workpackage entities.
PlanDataByKeyFluentHelper	getPlanDataByKey(String projectID, String resType, String workPackageID, String resourceId, String version, String employee, String confirmed, String workitemId, String delvryServOrg) Fetch a single PlanData entity using key fields.
ProjectByKeyFluentHelper	getProjectByKey(String projectID) Fetch a single Project entity using key fields.
StaffingDataByKeyFluentHelper	getStaffingDataByKey(String projectID, String workPackageID, String resType, String resourceId, String workitemId) Fetch a single StaffingData entity using key fields.
WorkItemByKeyFluentHelper	getWorkItemByKey(String workitem, String workpackageID) Fetch a single WorkItem entity using key fields.
WorkpackageByKeyFluentHelper	getWorkpackageByKey(String workPackageID) Fetch a single Workpackage entity using key fields.
CommercialProjectDetailService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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

CommercialProjectDetailService 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

getAllProject

@Nonnull
ProjectFluentHelper getAllProject()

Fetch multiple Project entities.

Returns:

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

getProjectByKey

@Nonnull
ProjectByKeyFluentHelper getProjectByKey(String projectID)

Fetch a single Project entity using key fields.

Parameters:

projectID - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

Returns:

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

getAllWorkpackage

@Nonnull
WorkpackageFluentHelper getAllWorkpackage()

Fetch multiple Workpackage entities.

Returns:

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

getWorkpackageByKey

@Nonnull
WorkpackageByKeyFluentHelper getWorkpackageByKey(String workPackageID)

Fetch a single Workpackage entity using key fields.

Parameters:

workPackageID - Plan Item

Constraints: Not nullable, Maximum length: 50

Returns:

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

getAllPlanData

@Nonnull
PlanDataFluentHelper getAllPlanData()

Fetch multiple PlanData entities.

Returns:

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

getPlanDataByKey

@Nonnull
PlanDataByKeyFluentHelper getPlanDataByKey(String projectID,
                                                    String resType,
                                                    String workPackageID,
                                                    String resourceId,
                                                    String version,
                                                    String employee,
                                                    String confirmed,
                                                    String workitemId,
                                                    String delvryServOrg)

Fetch a single PlanData entity using key fields.

Parameters:

workitemId - Work Item ID

Constraints: Not nullable, Maximum length: 10

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

resType - Used to uniquely identify the resource type.

Constraints: Not nullable, Maximum length: 4

employee - Contains a unique eight-digit numerical code that represents a specific object (for example, an organizational unit, qualification or business event).

Constraints: Not nullable, Maximum length: 8

projectID - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

version - A plan version is used to create different types of project estimates. Each version is associated with different version types that categorize versions into quote, baseline, current, and forecast.

Constraints: Not nullable, Maximum length: 28

confirmed - Confirmation of staffed Employee

Constraints: Not nullable, Maximum length: 1

Returns:

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

getAllWorkItem

@Nonnull
WorkItemFluentHelper getAllWorkItem()

Fetch multiple WorkItem entities.

Returns:

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

getWorkItemByKey

@Nonnull
WorkItemByKeyFluentHelper getWorkItemByKey(String workitem,
                                                    String workpackageID)

Fetch a single WorkItem entity using key fields.

Parameters:

workpackageID - Plan Item

Constraints: Not nullable, Maximum length: 50

workitem - Work Item ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllStaffingData

@Nonnull
StaffingDataFluentHelper getAllStaffingData()

Fetch multiple StaffingData entities.

Returns:

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

getStaffingDataByKey

@Nonnull
StaffingDataByKeyFluentHelper getStaffingDataByKey(String projectID,
                                                            String workPackageID,
                                                            String resType,
                                                            String resourceId,
                                                            String workitemId)

Fetch a single StaffingData entity using key fields.

Parameters:

workitemId - Work Item ID

Constraints: Not nullable, Maximum length: 10

resourceId - Used to uniquely identify a resource.

Constraints: Not nullable, Maximum length: 40

workPackageID - Plan Item

Constraints: Not nullable, Maximum length: 50

resType - Used to uniquely identify the resource type.

Constraints: Not nullable, Maximum length: 4

projectID - Identifies a master project.

Constraints: Not nullable, Maximum length: 40

Returns:

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