• [0]: object ApiEntityProjectsAggregate

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityProjectsAggregate"
    }
}

• actualDuration(optional): object Duration
• actualFinishDate(optional): string(date-time)
  The date on which a project is considered complete.
• actualStartDate(optional): string(date-time)
  Indicates the date work on the project began.
• aggregateId: integer(int64)
  The unique identifier of a rollup.
• finishDate(optional): string(date-time)
  The date on which work on the project ends.
• finishDateVariance(optional): object Duration
• forecastFinishDate(optional): string(date-time)
  The planned finish date of a project's remaining forecast cost.
• forecastStartDate(optional): string(date-time)
  The planned start date of a project's remaining forecast cost.
• link(optional): string(url)
  Read Only: true
• percentComplete(optional): object Percent
• planEndDate(optional): string(date-time)
  The finish date for the time phased planned budget of the project. Planned budget cost spread will adjust when this date is changed.
• plannedDuration(optional): object Duration
• planStartDate(optional): string(date-time)
  The start date for the time phased planned budget of the project. Planned budget cost spread will adjust when this date is changed. The project planned start also represents the earliest date that activities can occur within a project schedule.
• projectAggregateFinancial(optional): object ApiEntityProjectsAggregateFinancial
• projectsAggregateConfiguredFields(optional): object ApiEntityProjectsAggregateConfiguredFields
• recordCount(optional): integer(int32)
  The number of comments on a project.
• referenceObjectId: integer(int64)
  The unique identifier of a project cost reference.
• remainingDuration(optional): object Duration
• rollupType(optional): string
  Allowed Values: [ "PROJECT_2_CAPITAL_PLAN", "PROJECT_PORTFOLIO" ]

  The type of rollup.
• spendEffectiveDate(optional): string(date-time)
  The month in which an actuals value was last added to the project.
• startDate(optional): string(date-time)
  The date on which work on the project begins.
• startDateVariance(optional): object Duration
• uniqueName(optional): string
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "aggregateId",
        "referenceObjectId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "plannedDuration":{
            "description":"The duration between <b>project planned start</b> and <b>project planned finish</b>.",
            "$ref":"#/definitions/Duration"
        },
        "finishDateVariance":{
            "description":"The duration between the project's finish date and default snapshot.",
            "$ref":"#/definitions/Duration"
        },
        "remainingDuration":{
            "description":"The duration between the <b>project start</b> and <b>project finish</b>.",
            "$ref":"#/definitions/Duration"
        },
        "actualFinishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which a project is considered complete."
        },
        "forecastStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The planned start date of a project's remaining <b>forecast</b> cost."
        },
        "forecastFinishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The planned finish date of a project's remaining <b>forecast</b> cost."
        },
        "startDateVariance":{
            "description":"The duration between the project's start date and default snapshot.",
            "$ref":"#/definitions/Duration"
        },
        "actualStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"Indicates the date work on the project began."
        },
        "actualDuration":{
            "description":"The total working time between the project <b>actual start</b> and <b>actual finish</b>.",
            "$ref":"#/definitions/Duration"
        },
        "spendEffectiveDate":{
            "type":"string",
            "format":"date-time",
            "description":"The month in which an actuals value was last added to the project."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which work on the project begins."
        },
        "rollupType":{
            "type":"string",
            "description":"The type of rollup.",
            "enum":[
                "PROJECT_2_CAPITAL_PLAN",
                "PROJECT_PORTFOLIO"
            ]
        },
        "aggregateId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a rollup."
        },
        "planStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The start date for the time phased <b>planned budget</b> of the project. <b>Planned budget</b> cost spread will adjust when this date is changed. The <b>project planned start</b> also represents the earliest date that activities can occur within a project schedule."
        },
        "finishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which work on the project ends."
        },
        "planEndDate":{
            "type":"string",
            "format":"date-time",
            "description":"The finish date for the time phased <b>planned budget</b> of the project. <b>Planned budget</b> cost spread will adjust when this date is changed."
        },
        "recordCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of comments on a project."
        },
        "percentComplete":{
            "description":"The estimated percentage of work that has been completed on the project.",
            "$ref":"#/definitions/Percent"
        },
        "uniqueName":{
            "type":"string"
        },
        "referenceObjectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project cost reference."
        },
        "projectAggregateFinancial":{
            "description":"An object containing financial fields associated with the project aggregate in the form of key-value pairs.",
            "$ref":"#/definitions/ApiEntityProjectsAggregateFinancial"
        },
        "projectsAggregateConfiguredFields":{
            "description":"The configured fields of a project aggregate.",
            "$ref":"#/definitions/ApiEntityProjectsAggregateConfiguredFields"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• bigDecimal(optional): number
• double(optional): number(double)

{
    "type":"object",
    "properties":{
        "double":{
            "type":"number",
            "format":"double"
        },
        "bigDecimal":{
            "type":"number"
        }
    }
}

• bigDecimal(optional): number
• double(optional): number(double)

{
    "type":"object",
    "properties":{
        "double":{
            "type":"number",
            "format":"double"
        },
        "bigDecimal":{
            "type":"number"
        }
    }
}

• actualCost(optional): object Cost
• aggregateId: integer(int64)
  The unique identifier of a rollup.
• annualDiscountRate(optional): object Percent
• atCompletionCost(optional): object Cost
• costPerfIndex(optional): number(double)
  The measure of a project's cost efficiency.
• costVariance(optional): object Cost
• currApprSpendVar(optional): object Cost
• currentApprovedBudget(optional): object Cost
• currentApprovedBudgetDistributed(optional): object Cost
• currentApprovedBudgetUndistributed(optional): object Cost
• earnedValueCost(optional): object Cost
• estAtCompleteCost(optional): object Cost
• estToCompleteCost(optional): object Cost
• forecastCost(optional): object Cost
• forecastCostDistributed(optional): object Cost
• forecastCostUndistributed(optional): object Cost
• forecastCurrApprVar(optional): object Cost
• internalRateOfReturn(optional): object Percent
• link(optional): string(url)
  Read Only: true
• netPresentValue(optional): object Cost
• paybackPeriod(optional): number(double)
  The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected project.
• plannedBudget(optional): object Cost
• plannedBudgetDistributed(optional): object Cost
• plannedBudgetUndistributed(optional): object Cost
• plannedValueCost(optional): object Cost
• profitabilityIndex(optional): number(double)
  The index based on the value of a project's present values divided by initial project investments.
• proposedBudgetBase(optional): object Cost
• proposedBudgetBaseDistributed(optional): object Cost
• proposedBudgetBaseUndistributed(optional): object Cost
• proposedForecastVar(optional): object Cost
• proposedPlannedVar(optional): object Cost
• referenceObjectId: integer(int64)
  The unique identifier of a project cost reference.
• remainingCost(optional): object Cost
• returnOnInvestment(optional): object Percent
• rollupType(optional): string
  Allowed Values: [ "PROJECT_2_CAPITAL_PLAN", "PROJECT_PORTFOLIO" ]

  The type of rollup.
• schedPerfIndex(optional): number(double)
  The measure of work accomplished as a percentage of the work scheduled on a project.
• scheduleVariance(optional): object Cost
• spendCost(optional): object Cost
• spendForecastVar(optional): object Cost
• spendPlannedVar(optional): object Cost
• uniqueName(optional): string
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• yearEndForecastCost(optional): object Cost
• ytdSpendCost(optional): object Cost

{
    "type":"object",
    "required":[
        "aggregateId",
        "referenceObjectId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "rollupType":{
            "type":"string",
            "description":"The type of rollup.",
            "enum":[
                "PROJECT_2_CAPITAL_PLAN",
                "PROJECT_PORTFOLIO"
            ]
        },
        "aggregateId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a rollup."
        },
        "costVariance":{
            "description":"The measure of cost performance on a project.",
            "$ref":"#/definitions/Cost"
        },
        "forecastCost":{
            "description":"The total estimation of a project's remaining costs.",
            "$ref":"#/definitions/Cost"
        },
        "ytdSpendCost":{
            "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.",
            "$ref":"#/definitions/Cost"
        },
        "plannedBudget":{
            "description":"The planned total cost of a project. ",
            "$ref":"#/definitions/Cost"
        },
        "actualCost":{
            "description":"Total costs accrued on a project within a given time period.",
            "$ref":"#/definitions/Cost"
        },
        "paybackPeriod":{
            "type":"number",
            "format":"double",
            "description":"The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected project."
        },
        "costPerfIndex":{
            "type":"number",
            "format":"double",
            "description":"The measure of a project's cost efficiency."
        },
        "remainingCost":{
            "description":"The remaining total cost for the project, including labor resources, nonlabor resources, and project expenses.",
            "$ref":"#/definitions/Cost"
        },
        "spendCost":{
            "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the cost of invoices, payments, or accruals.",
            "$ref":"#/definitions/Cost"
        },
        "uniqueName":{
            "type":"string"
        },
        "proposedBudgetBaseUndistributed":{
            "description":"The proposed budget allocated to a project.",
            "$ref":"#/definitions/Cost"
        },
        "referenceObjectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project cost reference."
        },
        "scheduleVariance":{
            "description":"The measure of schedule performance on a project.",
            "$ref":"#/definitions/Cost"
        },
        "earnedValueCost":{
            "description":"The value of work performed on a project in reference to the approved budget for the project.",
            "$ref":"#/definitions/Cost"
        },
        "plannedValueCost":{
            "description":"The amount of approved capital spent on a scheduled portion of work on a project.",
            "$ref":"#/definitions/Cost"
        },
        "netPresentValue":{
            "description":"The difference between the present value (PV) of the future cash flows from current investments and project costs.",
            "$ref":"#/definitions/Cost"
        },
        "annualDiscountRate":{
            "description":"The interest rate associated with the cost of an investment.",
            "$ref":"#/definitions/Percent"
        },
        "profitabilityIndex":{
            "type":"number",
            "format":"double",
            "description":"The index based on the value of a project's present values divided by initial project investments."
        },
        "proposedBudgetBaseDistributed":{
            "description":"The proposed budget allocated to a project.",
            "$ref":"#/definitions/Cost"
        },
        "plannedBudgetDistributed":{
            "description":"The planned total cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "forecastCostDistributed":{
            "description":"The total estimation of a project's remaining costs.",
            "$ref":"#/definitions/Cost"
        },
        "schedPerfIndex":{
            "type":"number",
            "format":"double",
            "description":"The measure of work accomplished as a percentage of the work scheduled on a project."
        },
        "proposedBudgetBase":{
            "description":"The proposed budget allocated to a project.",
            "$ref":"#/definitions/Cost"
        },
        "atCompletionCost":{
            "description":"The <b>at completion</b> total cost from a cost-loaded P6 schedule.",
            "$ref":"#/definitions/Cost"
        },
        "estAtCompleteCost":{
            "description":"The expected total cost of the project when the defined scope of work will be completed.",
            "$ref":"#/definitions/Cost"
        },
        "plannedBudgetUndistributed":{
            "description":"The planned total cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "spendForecastVar":{
            "description":"The variance between a project's actual cost and forecast.",
            "$ref":"#/definitions/Cost"
        },
        "forecastCostUndistributed":{
            "description":"The total estimation of a project's remaining costs.",
            "$ref":"#/definitions/Cost"
        },
        "forecastCurrApprVar":{
            "description":"The total and time phased variance between the project's <b>forecast</b> and <b>approved budget</b>.",
            "$ref":"#/definitions/Cost"
        },
        "estToCompleteCost":{
            "description":"The estimated cost needed to complete the project.",
            "$ref":"#/definitions/Cost"
        },
        "proposedPlannedVar":{
            "description":"The total and time phased variance between the project's <b>proposed budget</b> and <b>planned budget</b>.",
            "$ref":"#/definitions/Cost"
        },
        "yearEndForecastCost":{
            "description":"Total forecast at the end of year actuals till date, with respect to the current year.",
            "$ref":"#/definitions/Cost"
        },
        "currentApprovedBudget":{
            "description":"The budget currently approved for the project. Current approved budget values are derived from the <b>proposed budget</b>.",
            "$ref":"#/definitions/Cost"
        },
        "currApprSpendVar":{
            "description":"The variance between a project's approved budget and actual cost.",
            "$ref":"#/definitions/Cost"
        },
        "internalRateOfReturn":{
            "description":"The quantitative measurement used to compare the profitability of project investments. The rate at which investors will receive returns on their investments in a project. This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Percent"
        },
        "returnOnInvestment":{
            "description":"The percentage resulting from division of the expected returns of an investment by the investment costs of a project or portfolio.",
            "$ref":"#/definitions/Percent"
        },
        "proposedForecastVar":{
            "description":"The total and time phased variance between the project's <b>proposed budget</b> and <b>forecast</b>.",
            "$ref":"#/definitions/Cost"
        },
        "spendPlannedVar":{
            "description":"The variance between a project's actual cost and planned budget.",
            "$ref":"#/definitions/Cost"
        },
        "currentApprovedBudgetDistributed":{
            "description":"The budget currently approved for the project. Current approved budget values are derived from the <b>proposed budget</b> set by the budget planner. A <b>proposed budget</b> becomes the <b>approved budget</b> after the budget scenario has undergone the approval process.",
            "$ref":"#/definitions/Cost"
        },
        "currentApprovedBudgetUndistributed":{
            "description":"The budget currently approved for the project. Current approved budget values are derived from the <b>proposed budget</b>. A <b>proposed budget</b> becomes an <b>approved budget</b> after the budget scenario has undergone the approval process.",
            "$ref":"#/definitions/Cost"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• aggregateId: integer(int64)
  The unique identifier of a rollup.
• costFlexMap(optional): object costFlexMap
  Additional Properties Allowed: additionalProperties
• link(optional): string(url)
  Read Only: true
• otherFlexMap(optional): object otherFlexMap
  Additional Properties Allowed: additionalProperties
• referenceObjectId: integer(int64)
  The unique identifier of a project cost reference.
• rollupType: string
  Allowed Values: [ "PROJECT_2_CAPITAL_PLAN", "PROJECT_PORTFOLIO" ]

  The type of rollup.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "aggregateId",
        "referenceObjectId",
        "rollupType"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "rollupType":{
            "type":"string",
            "description":"The type of rollup.",
            "enum":[
                "PROJECT_2_CAPITAL_PLAN",
                "PROJECT_PORTFOLIO"
            ]
        },
        "aggregateId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a rollup."
        },
        "costFlexMap":{
            "type":"object",
            "description":"",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"",
            "additionalProperties":{
                "type":"object"
            }
        },
        "referenceObjectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project cost reference."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"",
    "additionalProperties":{
        "type":"object"
    }
}