Jump to

• Request
• Response

View all Budget Plan Projects

get

/api/restapi/budgetPlanningScenario/planProjects/scenario/{scenarioId}

Send a request to this endpoint to view all budget plan projects in the budget planning scenario.

Request

Path Parameters

• scenarioId(required): integer(int64)
  The system-generated identifier of an Budget Plan Scenario.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityBudgetPlanProject>

Type: array

Title: List<ApiEntityBudgetPlanProject>

Show Source

• Array of: object ApiEntityBudgetPlanProject
  Title: ApiEntityBudgetPlanProject

{
    "title":"List<ApiEntityBudgetPlanProject>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetPlanProject",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBudgetPlanProject

Type: object

Title: ApiEntityBudgetPlanProject

Show Source

• costCurves: array costCurves
  The phase costs associated with a plan project.
• description: string
  Maximum Length: 4000

  The description of a plan project.
• distributed: number (double)
  The amount of budget currently allocated across the project timescale.
• distributedWorkspace1: number (double)
  The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace1 currency.
• distributedWorkspace2: number (double)
  The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace2 currency.
• distributedWorkspace3: number (double)
  The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace3 currency.
• finishDate: string (date-time)
  The finish date of a plan project.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• linked: boolean
  The flag to link or unlink a project in a scenario.
• planProjectPeriods: array planProjectPeriods
  The period budgets associated with a plan project.
• planProjectSubCurveDetails: array planProjectSubCurveDetails
  The capital and expense cost details of a plan project.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier of a project.
• projectName: string
  Maximum Length: 255

  The name of a plan project associated with a scenario.
• projectStatus: string
  Allowed Values: [ "PENDING", "ACCEPTED", "CHANGES_REQUESTED" ]

  The budget review status of a plan project associated with a scenario.
• startDate: string (date-time)
  The start date of a plan project.
• state: string
  Allowed Values: [ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ]

  The state of capital plan project.
• total: number (double)
  The total amount of budget for the project based on base currency.
• totalWorkspace1: number (double)
  The total amount of budget for the project based on the workspace currency. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The total amount of budget for the project based on the workspace currency. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The total amount of budget for the project based on the workspace currency. This value is based on the workspace3 currency.
• undistributed: number (double)
  The amount of budget currently unallocated across the project timescale.
• undistributedWorkspace1: number (double)
  The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace1 currency.
• undistributedWorkspace2: number (double)
  The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace2 currency.
• undistributedWorkspace3: number (double)
  The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBudgetPlanProject",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The start date of a plan project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The finish date of a plan project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "undistributed":{
            "type":"number",
            "description":"The amount of budget currently unallocated across the project timescale.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributed":{
            "type":"number",
            "description":"The amount of budget currently allocated across the project timescale.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "type":"number",
            "description":"The total amount of budget for the project based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "planProjectPeriods":{
            "type":"array",
            "description":"The period budgets associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "costCurves":{
            "type":"array",
            "description":"The phase costs associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCostCurve",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "planProjectSubCurveDetails":{
            "type":"array",
            "description":"The capital and expense cost details of a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntitySubCostCurve",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "undistributedWorkspace1":{
            "type":"number",
            "description":"The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace2":{
            "type":"number",
            "description":"The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace3":{
            "type":"number",
            "description":"The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace1":{
            "type":"number",
            "description":"The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace2":{
            "type":"number",
            "description":"The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace3":{
            "type":"number",
            "description":"The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The total amount of budget for the project based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The total amount of budget for the project based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The total amount of budget for the project based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "state":{
            "type":"string",
            "description":"The state of capital plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SELECTED",
                "UNSELECTED",
                "FORCED_IN",
                "FORCED_OUT"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"The description of a plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of  a plan project associated with a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectStatus":{
            "type":"string",
            "description":"The budget review status of a plan project associated with a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "ACCEPTED",
                "CHANGES_REQUESTED"
            ]
        },
        "linked":{
            "type":"boolean",
            "description":"The flag to link or unlink a project in a scenario.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : costCurves

Type: array

The phase costs associated with a plan project.

Show Source

• Array of: object ApiEntityCostCurve
  Title: ApiEntityCostCurve

{
    "type":"array",
    "description":"The phase costs associated with a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCostCurve",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : planProjectPeriods

Type: array

The period budgets associated with a plan project.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancial
  Title: ApiEntityScenarioPhaseFinancial

{
    "type":"array",
    "description":"The period budgets associated with a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : planProjectSubCurveDetails

Type: array

The capital and expense cost details of a plan project.

Show Source

• Array of: object ApiEntitySubCostCurve
  Title: ApiEntitySubCostCurve

{
    "type":"array",
    "description":"The capital and expense cost details of a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySubCostCurve",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCostCurve

Type: object

Title: ApiEntityCostCurve

Show Source

• costCurvePeriods: array costCurvePeriods
  The phase wise costs of cost curve.
• costCurveType: string
  Maximum Length: 255

  The type of the cost curve.
• distributed: number (double)
  The distributed cost of the cost curve.
• distributedWorkspace1: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.
• distributedWorkspace2: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.
• distributedWorkspace3: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.
• finishDate: string (date-time)
  The finish date of the cost curve.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• startDate: string (date-time)
  The start date of the cost curve.
• total: number (double)
  The total cost of the cost curve based on base currency.
• totalWorkspace1: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.
• undistributed: number (double)
  The undistributed cost of the cost curve.
• undistributedWorkspace1: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace1 currency.
• undistributedWorkspace2: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace2 currency.
• undistributedWorkspace3: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace2 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCostCurve",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The start date of the cost curve.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The finish date of the cost curve.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "undistributed":{
            "type":"number",
            "description":"The undistributed cost of the cost curve.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributed":{
            "type":"number",
            "description":"The distributed cost of the cost curve.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "type":"number",
            "description":"The total cost of the cost curve based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace1":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace2":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace3":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace1":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace2":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace3":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costCurveType":{
            "maxLength":"255",
            "type":"string",
            "description":"The type of the cost curve.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCurvePeriods":{
            "type":"array",
            "description":"The phase wise costs of cost curve.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : costCurvePeriods

Type: array

The phase wise costs of cost curve.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancial
  Title: ApiEntityScenarioPhaseFinancial

{
    "type":"array",
    "description":"The phase wise costs of cost curve.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityScenarioPhaseFinancial

Type: object

Title: ApiEntityScenarioPhaseFinancial

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• month: integer (int32)
  The month of phase period of a target or proposed budget.
• phaseCost: number (double)
  The amount of a target or proposed budget for a particular period based on base currency.
• phaseCostWorkspace1: number (double)
  The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace1 currency.
• phaseCostWorkspace2: number (double)
  The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace2 currency.
• phaseCostWorkspace3: number (double)
  The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.
• year: integer (int32)
  The year of phase period of a target or proposed budget.

{
    "title":"ApiEntityScenarioPhaseFinancial",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "year":{
            "type":"integer",
            "description":"The year of phase period of a target or proposed budget.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The month of phase period of a target or proposed budget.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "phaseCost":{
            "type":"number",
            "description":"The amount of a target or proposed budget for a particular period based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "phaseCostWorkspace1":{
            "type":"number",
            "description":"The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "phaseCostWorkspace2":{
            "type":"number",
            "description":"The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "phaseCostWorkspace3":{
            "type":"number",
            "description":"The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntitySubCostCurve

Type: object

Title: ApiEntitySubCostCurve

Show Source

• costCurvePeriods: array costCurvePeriods
  The phase wise costs of cost curve.
• costSubCurveType: string
  Allowed Values: [ "CAPITAL", "EXPENSE" ]

  The type of the cost curve.
• distributed: number (double)
  The distributed cost of the cost curve.
• distributedWorkspace1: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.
• distributedWorkspace2: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.
• distributedWorkspace3: number (double)
  The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• total: number (double)
  The total cost of the cost curve based on base currency.
• totalWorkspace1: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.
• totalWorkspace2: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.
• totalWorkspace3: number (double)
  The total cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.
• undistributed: number (double)
  The undistributed cost of the cost curve.
• undistributedWorkspace1: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace1 currency.
• undistributedWorkspace2: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace2 currency.
• undistributedWorkspace3: number (double)
  The undistributed cost of the cost curve. This value is based on the workspace2 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntitySubCostCurve",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costSubCurveType":{
            "type":"string",
            "description":"The type of the cost curve.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CAPITAL",
                "EXPENSE"
            ]
        },
        "undistributed":{
            "type":"number",
            "description":"The undistributed cost of the cost curve.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributed":{
            "type":"number",
            "description":"The distributed cost of the cost curve.",
            "format":"double",
            "exampleSetFlag":false
        },
        "total":{
            "type":"number",
            "description":"The total cost of the cost curve based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace1":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace2":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "undistributedWorkspace3":{
            "type":"number",
            "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace1":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace2":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "distributedWorkspace3":{
            "type":"number",
            "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace1":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace2":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWorkspace3":{
            "type":"number",
            "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costCurvePeriods":{
            "type":"array",
            "description":"The phase wise costs of cost curve.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : costCurvePeriods

Type: array

The phase wise costs of cost curve.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancial
  Title: ApiEntityScenarioPhaseFinancial

{
    "type":"array",
    "description":"The phase wise costs of cost curve.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

204 Response

Successful operation with no content.

404 Response

The requested scenario does not exist, or you do not have access to it.

Back to Top