Scenarios Aggregate Object Reference

 

The time-series intervals contained in a scenario's Resource Requirements Forecast cannot be directly aggregated (e.g., summed, averaged, etc.) without being transformed into a time-series based on common interval definitions. Calendarization provides that transformation into monthly periods.

This request object is used in the simulations/aggregate endpoint to configure an aggregate operation. All scenario ids must refer to scenarios that have successfully completed (i.e., have final status number 7) and include a CalendarizedForecast object array in the Scenario response object.

  {
    "ReportDateStart": "2023-01-01",
    "ReportDateEnd": "2025-06-30",
    "ResourceType": "All",
    "AggregateFunction": "Sum",
    "ScenarioIds": [
        "xxxxx",
        "yyyyy" 
    ]
  }

Attributes

ReportDateStart - string - required

Starting date of time-series.

ReportDateEnd - string - required

Ending date of time-series.

ResourceType - string - required

Determines which resources are included in aggregate operation. Permitted values are: All, HardwareInventory, HardwareTransactions, SoftwareInventory, and FacilityResources.

AggregateFunction - string - required

Determines the aggregate operation. Valid values are: Sum and Avg.

ScenarioIds - array of strings - optional

List of scenario ids to include in aggregate operation.

 

This is the ScenariosAggregate response object.

  {
    "ReportStartDate": "2023-01-01",
    "ReportEndDate": "2025-06-30",
    "ResourceType": "All",
    "ScenarioIds": ["xxx", "yyy","zzz"],
    "HardwareInventory": [
      {
        "ReportPeriod": "2023-04",
        "PeriodNbr": 4,
        "ServerQtyStart": 262,
        "ServerQtyEnd": 262,
        "ProcessorQtyStart": 524,
        "ProcessorQtyEnd": 524,
        "CoreQtyStart": 16768,
        "CoreQtyEnd": 16768
      },
    ],
    "HardwareTransactions": [
      {
        "ReportPeriod": "2023-4",
        "PeriodNbr": 4,
        "ServerQtyAdds": 6,
        "ServerQtyRemovals": -12,
        "ProcessorQtyAdds": 12,
        "ProcessorQtyRemovals": -24,
        "CoreQtyAdds": 384,
        "CoreQtyRemovals": -384
      }
    ],
    "SoftwareInventory": [
        {
          "ReportPeriod": "2023-04",
          "PeriodNbr": 4,
          "Stack": [
            {
              "LicenseId": 1,
              "LicenseType": "Subscription",
              "LicenseMetric": "Server",
              "ContractType": "Coterminous",
              "RequiredQtyStart": 262,
              "RequiredQtyEnd": 262,
              "AvailableQtyStart": 280,
              "AvailableQtyEnd": 280,
              "ExcessQtyStart": 18,
              "ExcessQtyEnd": 18
            }
          ]
        }
    ],
    "FacilityResources": [
        {
          "ReportPeriod": "2023-04",
          "PeriodNbr": 4,
          "KilowattHrs": 126570,
          "RackUnitSlotQtyStart": 262,
          "RackUnitSlotQtyEnd": 262
        },
      ],
    },
  ]
  "ErrorMessage" : ""
  }