Get Should Start / Should Finish Report

GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/should-start-finish

Api key

Headers

X-COMPANY-ID string Required

The company's unique ID

Path parameters

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

Query parameters

startDate string Required
finishDate string Required
filterId array[integer(int64)]
activityCodeFilter array[integer(int64)]
filterWindow boolean
filter array[string]

Values are STARTED_ON_TIME, STARTED_LATE, DID_NOT_START, FINISHED_ON_TIME, FINISHED_LATE, DID_NOT_FINISH, SHOULD_HAVE_STARTED, or SHOULD_HAVE_FINISHED.

Responses

500 */*

Internal Server Error
200 */*

OK
Hide response attributes Show response attributes object
- total integer(int64)
- startedOnTimeInWindow integer(int64)
- finishedOnTimeInWindow integer(int64)
- startedLate integer(int64)
- finishedLate integer(int64)
- didNotStart integer(int64)
- didNotFinish integer(int64)
- totalOnTimeHitRate number(double)
- startedOnTimeHitRate number(double)
- finishedOnTimeHitRate number(double)
- startedLatePercentage number(double)
- didNotStartPercentage number(double)
- finishedLatePercentage number(double)
- didNotFinishPercentage number(double)
- activities array[object]
  
  Hide activities attributes Show activities attributes object
  
  id integer(int64)
  
  customId string
  
  name string
  
  endingCustomId string
  
  endingName string
  
  startingStartDate string(date)
  
  startingFinishDate string(date)
  
  startingPercentComplete number(double)
  
  startingTotalFloat number(double)
  
  activityCodes array[object]
  
  Hide activityCodes attributes Show activityCodes attributes object
  
  activityCodeTypeId integer(int64)
  
  activityCodeId integer(int64)
  
  wbsId integer(int32)
  
  startingActuallyStarted boolean
  
  startingActuallyFinished boolean
  
  endingStartDate string(date)
  
  didNotStart boolean
  
  lateStart boolean
  
  endingFinishDate string(date)
  
  didNotFinish boolean
  
  lateFinish boolean
  
  endingPercentComplete number(double)
  
  endingTotalFloat number(double)
  
  varianceStartDate integer(int64)
  
  varianceFinishDate integer(int64)
  
  variancePercentComplete number(double)
  
  varianceTotalFloat number(double)
  
  deleted boolean
  
  endingActuallyStarted boolean
  
  endingActuallyFinished boolean
  
  startedOnTimeInWindow boolean
  
  finishedOnTimeInWindow boolean

GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/should-start-finish

curl \
 --request GET 'https://live.smartpmtech.com/public/v1/projects/{projectId}/scenarios/{scenarioId}/should-start-finish?startDate=string&finishDate=string' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"

Response examples (500)

{}

Response examples (200)

{
  "total": 42,
  "startedOnTimeInWindow": 42,
  "finishedOnTimeInWindow": 42,
  "startedLate": 42,
  "finishedLate": 42,
  "didNotStart": 42,
  "didNotFinish": 42,
  "totalOnTimeHitRate": 42.0,
  "startedOnTimeHitRate": 42.0,
  "finishedOnTimeHitRate": 42.0,
  "startedLatePercentage": 42.0,
  "didNotStartPercentage": 42.0,
  "finishedLatePercentage": 42.0,
  "didNotFinishPercentage": 42.0,
  "activities": [
    {
      "id": 42,
      "customId": "string",
      "name": "string",
      "endingCustomId": "string",
      "endingName": "string",
      "startingStartDate": "2025-05-04",
      "startingFinishDate": "2025-05-04",
      "startingPercentComplete": 42.0,
      "startingTotalFloat": 42.0,
      "activityCodes": [
        {
          "activityCodeTypeId": 42,
          "activityCodeId": 42
        }
      ],
      "wbsId": 42,
      "startingActuallyStarted": true,
      "startingActuallyFinished": true,
      "endingStartDate": "2025-05-04",
      "didNotStart": true,
      "lateStart": true,
      "endingFinishDate": "2025-05-04",
      "didNotFinish": true,
      "lateFinish": true,
      "endingPercentComplete": 42.0,
      "endingTotalFloat": 42.0,
      "varianceStartDate": 42,
      "varianceFinishDate": 42,
      "variancePercentComplete": 42.0,
      "varianceTotalFloat": 42.0,
      "deleted": true,
      "endingActuallyStarted": true,
      "endingActuallyFinished": true,
      "startedOnTimeInWindow": true,
      "finishedOnTimeInWindow": true
    }
  ]
}