Set the financial project plan to baseline
post
/fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/baselineFinancialProjectPlan
This action will set the financial project plan to baseline. Additionally, you can create a budget version and baseline it.
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
autoBaselineFlag: boolean
Indicates if the budget that was created using the financial plan type is baselined.
-
budgetFinancialPlanType: string
The name of the financial plan type that is used to create the budget version. If you specify the financial plan type, a budget is created from the baselined project plan.
-
projectId: number
The identifier of the project for which the financial project plan is being set to baseline.
-
projectName: string
The name of the project for which the financial project plan is being set to baseline.
-
projectNumber: string
The number of the project for which the financial project plan is being set to baseline.
-
taskNumberList: array
taskNumberList
The tasks that are selected to be baselined from the financial project plan. The default is to baseline all the tasks in the project.
Nested Schema : taskNumberList
Type:
array
The tasks that are selected to be baselined from the financial project plan. The default is to baseline all the tasks in the project.
Show Source
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): object
result
Additional Properties Allowed: additionalPropertiesIndicates if the baseline process is completed successfully.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Indicates if the baseline process is completed successfully.
Examples
The following example shows how to set the financial project plan to baseline by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.oracle.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/baselineFinancialProjectPlan" -H 'cache-control: no-cache'
Request Body Example
The following shows an example of the request body in JSON format.
{ { "projectName":"0002 PJS CDRM AM" }, { "taskNumberList":[ "1.1", "1.2" ] }, { "budgetFinancialPlanType":"Estimate" }, { "autoBaselineFlag":true } }
Response Body Example
The following shows an example of the response body in JSON format.
{ "result": { "Result": "A baseline was set for the project plan and a budget was generated." } }