Jump to

• Request
• Response
• Examples

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

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "autoBaselineFlag":{
            "type":"boolean",
            "description":"Indicates if the budget that was created using the financial plan type is baselined.",
            "nullable":true
        },
        "projectNumber":{
            "type":"string",
            "description":"The number of the project for which the financial project plan is being set to baseline.",
            "nullable":true
        },
        "taskNumberList":{
            "type":"array",
            "description":"The tasks that are selected to be baselined from the financial project plan. The default is to baseline all the tasks in the project.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "budgetFinancialPlanType":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "projectName":{
            "type":"string",
            "description":"The name of the project for which the financial project plan is being set to baseline.",
            "nullable":true
        },
        "projectId":{
            "type":"number",
            "description":"The identifier of the project for which the financial project plan is being set to baseline.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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

• Array of: string

{
    "type":"array",
    "description":"The tasks that are selected to be baselined from the financial project plan. The default is to baseline all the tasks in the project.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Indicates if the baseline process is completed successfully.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Indicates if the baseline process is completed successfully."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Indicates if the baseline process is completed successfully."
}

Indicates if the baseline process is completed successfully.

Back to Top

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."
    }
}

Back to Top