Oracle Prime Cloud Release 16

Creates a CapitalPlan.

post

/primeapi/restapi/v16.2/capitalPlan

Request

Supported Media Types

application/json
application/xml

Body Parameter

The CapitalPlan to be created.

Root Schema : ApiEntityCapitalPlan

Type: object

Properties

capitalPlanCostFlex: Type: object ApiEntityCapitalPlanCostFlex
capitalPlanFinancial: Type: object ApiEntityCapitalPlanFinancial
capitalPlanFlex: Type: object ApiEntityCapitalPlanFlex
capitalPlanId: Type: integer (int64)

Required: true
capitalPlanName: Type: string

Allowed Values: [ "Length[1-255]" ]
capitalPlanTextFlex: Type: object ApiEntityCapitalPlanTextFlex
capitalPortfolioId: Type: integer (int64)
comment: Type: string

Required: true

Allowed Values: [ "Length[0-4000]" ]
description: Type: string

Required: true

Allowed Values: [ "Length[0-4000]" ]
linkType: Type: string

Allowed Values: [ "FORECAST", "PLANNED_BUDGET" ]

Determines if linked projects in the capital plan link to project Forecast or Planned Budget. Linked values will be factored into a capital plan's Proposed Budget. Planner's can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans. The Proposed Budget Link Setting is stored at both the capital portfolio and capital plan levels. Any capital plan's added to a capital portfolio will inherit the value of its Proposed Budget Link Setting by default.
owner: Type: string

The user name of the user set as the manager or contact for the capital plan. The user who created the capital plan is set as the owner by default.
planPeriod: Type: integer (int32)
planStatus: Type: string

Allowed Values: [ "IN_PLANNING", "CLOSED", "APPROVED", "REVISING" ]

The current status of a capital plan. In Planning: The capital plan is currently going through the planning process and contains one or more scenarios in planning. This status is set based on the status of scenarios within the plan and cannot be edited manually. In planning is the default status for capital plans. Revising: The capital plan currently has one scenario with a status of approved, and another with a status of Under Review, Shared, or Under Approval. This status is set based on the status of scenarios within the plan and cannot be edited manually. Approved: The capital plan contains a scenario that has gone through the approval process and been approved. This status is set based on the status of scenarios within the plan and cannot be edited manually. Closed: The capital plan has manually been set to closed and will not be used in the future. No calculations can be performed on a closed capital plan. Capital plans with a status of Approved or In Planning can be Closed. Once a plan is Closed you can revert it back to its previous status, In Planning or Approved, if necessary. Capital plans with a status of Revising cannot be closed.
projectCount: Type: integer (int32)
securityGuid: Type: string

Required: true

Allowed Values: [ "Length[0-4000]" ]

Nested Schema : ApiEntityCapitalPlanCostFlex

Type: object

Properties

capitalPlan: Type: object ApiEntityCapitalPlan
capitalPlanId: Type: integer (int64)
flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured cost fields assigned to the CapitalPlan with its corresponding value as a (key,value) pair.

Nested Schema : ApiEntityCapitalPlanFinancial

Type: object

Properties

capitalPlan: Type: object ApiEntityCapitalPlan
capitalPlanId: Type: integer (int64)
currentApprovedBudget: Type: object Cost
currentApprovedBudgetDistributed: Type: object Cost
currentApprovedBudgetUndistributed: Type: object Cost
proposedBudget: Type: object Cost
proposedBudgetDistributed: Type: object Cost
proposedBudgetUndistributed: Type: object Cost
targetBudget: Type: object Cost
targetBudgetDistributed: Type: object Cost
targetBudgetUndistributed: Type: object Cost

Nested Schema : ApiEntityCapitalPlanFlex

Type: object

Properties

capitalPlan: Type: object ApiEntityCapitalPlan
capitalPlanId: Type: integer (int64)

Required: true
flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured date, number, integer fields assigned to the CapitalPlan with its corresponding value as a (key,value) pair.

Nested Schema : ApiEntityCapitalPlanTextFlex

Type: object

Properties

capitalPlan: Type: object ApiEntityCapitalPlan
capitalPlanId: Type: integer (int64)

Required: true
flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured text fields assigned to the CapitalPlan with its corresponding value as a (key,value) pair.

Nested Schema : flexMap

Type: object

Additional Properties Allowed

Type: object additionalProperties

Lists all configured cost fields assigned to the CapitalPlan with its corresponding value as a (key,value) pair.

Nested Schema : additionalProperties

Type: object

Nested Schema : Cost

Type: object

Nested Schema : flexMap

Type: object

Additional Properties Allowed

Type: object additionalProperties

Lists all configured date, number, integer fields assigned to the CapitalPlan with its corresponding value as a (key,value) pair.

Nested Schema : additionalProperties

Type: object

Nested Schema : flexMap

Type: object

Additional Properties Allowed

Type: object additionalProperties

Lists all configured text fields assigned to the CapitalPlan with its corresponding value as a (key,value) pair.

Nested Schema : additionalProperties

Type: object

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Root Schema : ApiEntityCapitalPlan

Type: object

Properties

capitalPlanCostFlex: Type: object ApiEntityCapitalPlanCostFlex
capitalPlanFinancial: Type: object ApiEntityCapitalPlanFinancial
capitalPlanFlex: Type: object ApiEntityCapitalPlanFlex
capitalPlanId: Type: integer (int64)

Required: true
capitalPlanName: Type: string

Allowed Values: [ "Length[1-255]" ]
capitalPlanTextFlex: Type: object ApiEntityCapitalPlanTextFlex
capitalPortfolioId: Type: integer (int64)
comment: Type: string

Required: true

Allowed Values: [ "Length[0-4000]" ]
description: Type: string

Required: true

Allowed Values: [ "Length[0-4000]" ]
linkType: Type: string

Allowed Values: [ "FORECAST", "PLANNED_BUDGET" ]

Determines if linked projects in the capital plan link to project Forecast or Planned Budget. Linked values will be factored into a capital plan's Proposed Budget. Planner's can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans. The Proposed Budget Link Setting is stored at both the capital portfolio and capital plan levels. Any capital plan's added to a capital portfolio will inherit the value of its Proposed Budget Link Setting by default.
owner: Type: string

The user name of the user set as the manager or contact for the capital plan. The user who created the capital plan is set as the owner by default.
planPeriod: Type: integer (int32)
planStatus: Type: string

Allowed Values: [ "IN_PLANNING", "CLOSED", "APPROVED", "REVISING" ]

The current status of a capital plan. In Planning: The capital plan is currently going through the planning process and contains one or more scenarios in planning. This status is set based on the status of scenarios within the plan and cannot be edited manually. In planning is the default status for capital plans. Revising: The capital plan currently has one scenario with a status of approved, and another with a status of Under Review, Shared, or Under Approval. This status is set based on the status of scenarios within the plan and cannot be edited manually. Approved: The capital plan contains a scenario that has gone through the approval process and been approved. This status is set based on the status of scenarios within the plan and cannot be edited manually. Closed: The capital plan has manually been set to closed and will not be used in the future. No calculations can be performed on a closed capital plan. Capital plans with a status of Approved or In Planning can be Closed. Once a plan is Closed you can revert it back to its previous status, In Planning or Approved, if necessary. Capital plans with a status of Revising cannot be closed.
projectCount: Type: integer (int32)
securityGuid: Type: string

Required: true

Allowed Values: [ "Length[0-4000]" ]

Nested Schema : ApiEntityCapitalPlanCostFlex

Type: object

Properties

capitalPlan: Type: object ApiEntityCapitalPlan
capitalPlanId: Type: integer (int64)
flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured cost fields assigned to the CapitalPlan with its corresponding value as a (key,value) pair.

Nested Schema : ApiEntityCapitalPlanFinancial

Type: object

Properties

capitalPlan: Type: object ApiEntityCapitalPlan
capitalPlanId: Type: integer (int64)
currentApprovedBudget: Type: object Cost
currentApprovedBudgetDistributed: Type: object Cost
currentApprovedBudgetUndistributed: Type: object Cost
proposedBudget: Type: object Cost
proposedBudgetDistributed: Type: object Cost
proposedBudgetUndistributed: Type: object Cost
targetBudget: Type: object Cost
targetBudgetDistributed: Type: object Cost
targetBudgetUndistributed: Type: object Cost

Nested Schema : ApiEntityCapitalPlanFlex

Type: object

Properties

capitalPlan: Type: object ApiEntityCapitalPlan
capitalPlanId: Type: integer (int64)

Required: true
flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured date, number, integer fields assigned to the CapitalPlan with its corresponding value as a (key,value) pair.

Nested Schema : ApiEntityCapitalPlanTextFlex

Type: object

Properties

capitalPlan: Type: object ApiEntityCapitalPlan
capitalPlanId: Type: integer (int64)

Required: true
flexMap: Type: object flexMap

Additional Properties Allowed: additionalProperties

Lists all configured text fields assigned to the CapitalPlan with its corresponding value as a (key,value) pair.