Get Scenario Details

GET /public/v1/projects/{projectId}/scenarios/{scenarioId}

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required
  • scenarioId integer(int64) Required

Query parameters

  • dataDate string

Responses

  • 500 */*

    Internal Server Error

  • 200 */*

    OK

    Hide response attributes Show response attributes object

    A detailed response containing scenario information

    • id integer(int64) Required

      The unique identifier of the scenario

    • modelId integer(int64) Required

      The unique identifier of the model

    • name string Required

      The name of the scenario

    • description string Required

      The description of the scenario

    • dataDate string(date) Required

      The data date of the scenario

    • scenarioType string Required

      The type of the scenario

      Values are COMPLETE or PARTIAL.

    • activityId integer(int64) Required

      The unique identifier of the associated activity

    • plannedPercentComplete number(double) Required

      Planned Percent Complete

    • actualPercentComplete number(double) Required

      Actual Percent Complete

    • forecastedCompletion string(date) Required

      Forecasted Completion Date

    • scheduledCompletion string(date) Required

      Scheduled Completion Date

    • scheduleCompression number(double) Required

      Schedule Compression

    • scheduleQualityGrade string Required

      Schedule Quality Grade

    • criticalPathDelay integer(int64) Required

      Critical Path Delay in days

    • endDateVariance integer(int64) Required

      End Date Variance in days

    • futureRecovery integer(int64) Required

      Future Recovery in days

    • health integer(int32) Required

      Health Indicator

    • schedulePerformanceIndex number(double) Required

      Schedule Performance Index

    • baselineEndDate string(date) Required

      Baseline End Date

    • contractualEndDate string(date) Required

      Contractual End Date

    • plannedManpower number(double) Required

      Planned Manpower

    • earnedManpower number(double) Required

      Earned Manpower

    • remainingManpower number(double) Required

      Remaining Manpower

    • actualManpower number(double) Required

      Actual Manpower

    • currentEstimatedManpower number(double) Required

      Current Estimated Manpower

    • plannedBudget number(double) Required

      Planned Budget

    • remainingBudget number(double) Required

      Remaining Budget

    • earnedCost number(double) Required

      Earned Cost

    • manpowerPlannedPercentComplete number(double) Required

      Manpower Planned Percent Complete

    • manpowerActualPercentComplete number(double) Required

      Manpower Actual Percent Complete

    • manpowerPerformanceIndex number(double) Required

      Manpower Performance Index

    • costPlannedPercentComplete number(double) Required

      Cost Planned Percent Complete

    • costActualPercentComplete number(double) Required

      Cost Actual Percent Complete

    • costPerformanceIndex number(double) Required

      Cost Performance Index

    • resourceCount number(double) Required

      Resource Count

    • averageDurationVariance integer(int64) Required

      Average Duration Variance in days

    • auditDate string(date) Required

      Audit Date

GET /public/v1/projects/{projectId}/scenarios/{scenarioId}
curl \
 --request GET 'https://live.smartpmtech.com/public/v1/projects/{projectId}/scenarios/{scenarioId}' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"
Response examples (500)
{}
Response examples (200)
{
  "id": 123,
  "modelId": 456,
  "name": "Baseline Scenario",
  "description": "This is the baseline scenario for project X.",
  "dataDate": "2024-01-15",
  "scenarioType": "COMPLETE",
  "activityId": 789,
  "plannedPercentComplete": 75.5,
  "actualPercentComplete": 70.0,
  "forecastedCompletion": "2024-12-31",
  "scheduledCompletion": "2025-01-15",
  "scheduleCompression": 0.85,
  "scheduleQualityGrade": "A",
  "criticalPathDelay": 10,
  "endDateVariance": 15,
  "futureRecovery": 5,
  "health": 1,
  "schedulePerformanceIndex": 0.9,
  "baselineEndDate": "2024-11-30",
  "contractualEndDate": "2025-02-15",
  "plannedManpower": 1500.0,
  "earnedManpower": 1200.0,
  "remainingManpower": 300.0,
  "actualManpower": 1300.0,
  "currentEstimatedManpower": 1600.0,
  "plannedBudget": 500000.0,
  "remainingBudget": 100000.0,
  "earnedCost": 400000.0,
  "manpowerPlannedPercentComplete": 80.0,
  "manpowerActualPercentComplete": 75.0,
  "manpowerPerformanceIndex": 0.95,
  "costPlannedPercentComplete": 78.0,
  "costActualPercentComplete": 74.0,
  "costPerformanceIndex": 0.92,
  "resourceCount": 25.0,
  "averageDurationVariance": 3,
  "auditDate": "2024-06-30"
}