Do not miss any SmartPM Public API changes, ever again

Subscribe to the SmartPM Public API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
8 structure changes including:
8 Modifications
Modified 8
GET /public/v1/projects/{projectId}/rfis
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
GET /public/v1/projects/{projectId}/rfis/{rfiId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
POST /public/v1/projects/{projectId}/rfis
  • Body
  • application/json content type Modified
    • rfiQuestions property Modified
      • rfi property Added
    • rfiBallInCourtUsers property Modified
      • rfi property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
POST /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
PUT /public/v1/projects/{projectId}/rfis/{rfiId}
  • Body
  • application/json content type Modified
    • rfiQuestions property Modified
      • rfi property Added
    • rfiBallInCourtUsers property Modified
      • rfi property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalBallInCourtUsers property Modified
      • submittal property Added
    • submittalResponses property Modified
      • submittal property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
10 structure changes including:
10 Modifications
Modified 10 Breaking
GET /public/v1/projects/{projectId}/rfis
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
GET /public/v1/projects/{projectId}/rfis/{rfiId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/activities
  • Response
  • 200 response Modified
    • */* content type Modified
      • activityCodes property Added
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /public/v2/projects/{projectId}/scenarios/{scenarioId}/activities
  • Response
  • 200 response Modified
    • */* content type Modified
      • activityCodes property Added
POST /public/v1/projects/{projectId}/rfis
  • Body
  • application/json content type Modified
    • rfiQuestions property Modified
      • rfi property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
    • rfiBallInCourtUsers property Modified
      • rfi property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
POST /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /public/v1/projects/{projectId}/rfis/{rfiId}
  • Body
  • application/json content type Modified
    • rfiQuestions property Modified
      • rfi property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
    • rfiBallInCourtUsers property Modified
      • rfi property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalResponses property Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
9.18.0
10 structure changes including:
10 Modifications
Modified 10 Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/activities
  • Response
  • 200 response Modified
    • */* content type Modified
      • activityCodes property Removed
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/schedules
  • Response
  • 200 response Modified
    • */* content type Modified
      • importDate, uploadDate properties Added
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
GET /public/v1/quality-profiles
  • Response
  • 200 response Modified
    • */* content type Modified
      • version property Added
GET /public/v1/quality-profiles/{qualityProfileId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • version property Added
GET /public/v2/projects/{projectId}/scenarios/{scenarioId}/activities
  • Response
  • 200 response Modified
    • */* content type Modified
      • activityCodes property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /public/v2/projects/{projectId}/scenarios/{scenarioId}/schedules
  • Response
  • 200 response Modified
    • */* content type Modified
      • importDate, uploadDate properties Added
POST /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalLinkedActivities property Modified
      • activityId property Modified
        • Property is now required
          Breaking
    • projectId property Modified
      • Property is now required
        Breaking
    • submittalPackage property Modified
      • projectId property Modified
        • Property is now required
          Breaking
    • submittalType property Modified
      • projectId property Modified
        • Property is now required
          Breaking
    • submittalResponses property Modified
      • submittal property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
9.17.0
8 structure changes including:
8 Modifications
Modified 8 Breaking
GET /public/v1/projects/{projectId}/rfis
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
GET /public/v1/projects/{projectId}/rfis/{rfiId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /public/v1/projects/{projectId}/rfis
  • Body
  • application/json content type Modified
    • rfiQuestions property Modified
      • rfi property Added
    • rfiBallInCourtUsers property Modified
      • rfi property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Removed
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
PUT /public/v1/projects/{projectId}/rfis/{rfiId}
  • Body
  • application/json content type Modified
    • rfiQuestions property Modified
      • rfi property Added
    • rfiBallInCourtUsers property Modified
      • rfi property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • rfiLinkedActivities, rfiQuestions, rfiBallInCourtUsers properties Modified
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalLinkedActivities, submittalResponses properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
45 structure changes including:
45 Modifications
Modified 45 Breaking
GET /public/v1/projects/{projectId}/activity-code
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, value, desc, sequenceNumber, order properties Modified
        • Properties are now required
          Breaking
      • children property Modified
        • Property is now required
          Breaking
        • Type went from array to array[object]
        • object property Added
      • parent property Added
GET /public/v1/projects/{projectId}/activity-code-type
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, externalProjectId, sequenceNumber, secureCode, length, name, scope, epsId, epsNumber properties Modified
        • Properties are now required
          Breaking
      • activityCodes property Modified
        • Property is now required
          Breaking
        • id, value, desc, sequenceNumber, order properties Modified
          • Properties are now required
            Breaking
        • children property Modified
          • Property is now required
            Breaking
          • Type went from array to array[object]
        • parent property Added
GET /public/v1/projects/{projectId}/activity-code-type/{activityCodeTypeId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, externalProjectId, sequenceNumber, secureCode, length, name, scope, epsId, epsNumber properties Modified
        • Properties are now required
          Breaking
      • activityCodes property Modified
        • Property is now required
          Breaking
        • id, value, desc, sequenceNumber, order properties Modified
          • Properties are now required
            Breaking
        • children property Modified
          • Property is now required
            Breaking
          • Type went from array to array[object]
        • parent property Added
GET /public/v1/projects/{projectId}/activity-code-type/{activityCodeTypeId}/activity-codes/{activityCodeId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, value, desc, sequenceNumber, order properties Modified
        • Properties are now required
          Breaking
      • children property Modified
        • Property is now required
          Breaking
        • Type went from array to array[object]
        • object property Added
      • parent property Added
GET /public/v1/projects/{projectId}/calendars
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, baseCalendarId, defaultCalendar, name, type, hoursPerDay, hoursPerMonth, hoursPerWeek, hoursPerYear, worktimeList, externalId properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/calendars/{calendarId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, baseCalendarId, defaultCalendar, name, type, hoursPerDay, hoursPerMonth, hoursPerWeek, hoursPerYear, worktimeList, externalId properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/external-references
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, provider, externalId, externalCompanyId, externalBaseUrl properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/notes
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, note, user, userId, createdAt, updatedAt, viewedByUser, canEdit properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/notes/unread-note-count
  • Response
  • 200 response Modified
    • */* content type Modified
      • count property Modified
        • Property is now required
          Breaking
GET /public/v1/projects/{projectId}/scenarios
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, modelId, name, description, dataDate, scenarioType, activityId properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, modelId, name, description, dataDate, scenarioType, activityId, plannedPercentComplete, actualPercentComplete, forecastedCompletion, scheduledCompletion, scheduleCompression, scheduleQualityGrade, criticalPathDelay, endDateVariance, futureRecovery, health, schedulePerformanceIndex, baselineEndDate, contractualEndDate, plannedManpower, earnedManpower, remainingManpower, actualManpower, currentEstimatedManpower, plannedBudget, remainingBudget, earnedCost, manpowerPlannedPercentComplete, manpowerActualPercentComplete, manpowerPerformanceIndex, costPlannedPercentComplete, costActualPercentComplete, costPerformanceIndex, resourceCount, averageDurationVariance, auditDate properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/activities
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, activityId, name, percentCompleteType, durationPercentComplete, physicalPercentComplete, unitsPercentComplete, floatTotal, nativeFloatTotal, floatFree, activityType, constraintType, externalId, wbsId, calendarId, plannedDuration, remainingDuration, rolledBackRemainingDuration, actualDuration, plannedBudget, plannedManpower, durationVariance, drivers, driving, inLongestPath, retainLogic, deleted properties Modified
        • Properties are now required
      • baseline property Modified
        • Property is now required
        • startDate, finishDate, duration, critical, type properties Modified
          • Properties are now required
      • activityCodes, startDate, finishDate, lateStartDate, lateFinishDate, actualStartDate, actualFinishDate, constrainedDate, resumeDate, sourceStartDate, sourceFinishDate, sourceActualStartDate, sourceActualFinishDate, workDayDataDate properties Added
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/delay
  • Response
  • 200 response Modified
    • */* content type Modified
      • period, scheduleName, dataDate, endDate, endDateVariance, criticalPathDelay, criticalPathRecovery, delayRecovery, filterId, delays, recoveries properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/percent-complete-curve
  • Response
  • 200 response Modified
    • */* content type Modified
      • percentCompleteTypes, data properties Modified
        • Properties are now required
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/project-health
  • Response
  • 200 response Modified
    • */* content type Modified
      • dataDate, health, risk properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/project-health-trend
  • Response
  • 200 response Modified
    • */* content type Modified
      • dataDate, health, risk properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/relationships
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, predecessorId, successorId, type, lag properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/schedule-performance-index
  • Response
  • 200 response Modified
    • */* content type Modified
      • dataDate, spi properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/schedule-performance-index-trend
  • Response
  • 200 response Modified
    • */* content type Modified
      • dataDate, spi properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/schedules
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, fileName, fileId, activityCount, dataDate properties Modified
        • Properties are now required
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
GET /public/v1/projects/{projectId}/user-groups
  • Response
  • 200 response Modified
    • */* content type Modified
      • userGroup property Modified
        • Property is now required
          Breaking
        • id, name, users properties Modified
          • Properties are now required
            Breaking
GET /public/v1/projects/{projectId}/wbs
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, parentWBSId, sequenceNumber, code, name properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/wbs/{wbsId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, parentWBSId, sequenceNumber, code, name properties Modified
        • Properties are now required
          Breaking
GET /public/v1/session
  • Response
  • 200 response Modified
    • */* content type Modified
      • expiry property Modified
        • Property is now required
          Breaking
GET /public/v1/user-groups
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, name properties Modified
        • Properties are now required
          Breaking
      • users property Modified
        • Property is now required
          Breaking
        • id, firstName, lastName, email, phoneNumber, title, lastLogin, loginCount, role, ssoUser, reportingRestricted properties Modified
          • Properties are now required
            Breaking
GET /public/v1/user-groups/{userGroupId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, name properties Modified
        • Properties are now required
          Breaking
      • users property Modified
        • Property is now required
          Breaking
        • id, firstName, lastName, email, phoneNumber, title, lastLogin, loginCount, role, ssoUser, reportingRestricted properties Modified
          • Properties are now required
            Breaking
GET /public/v1/users
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, firstName, lastName, email, phoneNumber, title, lastLogin, loginCount, role, ssoUser, reportingRestricted properties Modified
        • Properties are now required
          Breaking
GET /public/v1/users/{userId}/project-roles
  • Response
  • 200 response Modified
    • */* content type Modified
      • userId property Modified
        • Property is now required
          Breaking
      • projectRoles property Modified
        • Property is now required
          Breaking
        • projectId, userRoleId, groupRoleId, effectiveRoleId, projectUserId, userGroupId, userGroupName properties Modified
          • Properties are now required
            Breaking
GET /public/v2/projects/{projectId}/scenarios/{scenarioId}/activities
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, activityId, name, percentCompleteType, durationPercentComplete, physicalPercentComplete, unitsPercentComplete, floatTotal, nativeFloatTotal, floatFree, activityType, constraintType, externalId, wbsId, calendarId, plannedDuration, remainingDuration, rolledBackRemainingDuration, actualDuration, plannedBudget, plannedManpower, durationVariance, drivers, driving, inLongestPath, retainLogic, deleted properties Modified
        • Properties are now required
          Breaking
      • baseline property Modified
        • Property is now required
          Breaking
        • startDate, finishDate, duration, critical, type properties Modified
          • Properties are now required
            Breaking
      • activityCodes, startDate, finishDate, lateStartDate, lateFinishDate, actualStartDate, actualFinishDate, constrainedDate, resumeDate, sourceStartDate, sourceFinishDate, sourceActualStartDate, sourceActualFinishDate, workDayDataDate properties Added
GET /public/v2/projects/{projectId}/scenarios/{scenarioId}/schedules
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, fileName, fileId, activityCount, dataDate, sourceEndDate, baseline properties Modified
        • Properties are now required
          Breaking
POST /public/v1/projects
  • Response
  • 200 response Modified
    • */* content type Modified
      • projectId, message, files properties Modified
        • Properties are now required
          Breaking
POST /public/v1/projects/{projectId}/external-references
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, provider, externalId, externalCompanyId, externalBaseUrl properties Modified
        • Properties are now required
          Breaking
POST /public/v1/projects/{projectId}/import
  • Response
  • 200 response Modified
    • */* content type Modified
      • files, importId, message, status properties Modified
        • Properties are now required
          Breaking
POST /public/v1/projects/{projectId}/notes
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, note, user, userId, createdAt, updatedAt, viewedByUser, canEdit properties Modified
        • Properties are now required
          Breaking
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is no longer object
        Breaking
      • SubmittalResponse property Removed
POST /public/v1/projects/{projectId}/user-groups
  • Response
  • 200 response Modified
    • */* content type Modified
      • userGroup property Modified
        • Property is now required
          Breaking
        • id, name, users properties Modified
          • Properties are now required
            Breaking
POST /public/v1/user-groups
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, name properties Modified
        • Properties are now required
          Breaking
      • users property Modified
        • Property is now required
          Breaking
        • id, firstName, lastName, email, phoneNumber, title, lastLogin, loginCount, role, ssoUser, reportingRestricted properties Modified
          • Properties are now required
            Breaking
POST /public/v1/users
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, firstName, lastName, email, phoneNumber, title, lastLogin, loginCount, role, ssoUser, reportingRestricted properties Modified
        • Properties are now required
          Breaking
PUT /public/v1/projects/{projectId}/notes/{noteId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, note, user, userId, createdAt, updatedAt, viewedByUser, canEdit properties Modified
        • Properties are now required
          Breaking
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalResponses, submittalLinkedActivities properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is no longer object
        Breaking
      • SubmittalResponse property Removed
PUT /public/v1/projects/{projectId}/user-groups/{projectUserGroupId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • userGroup property Modified
        • Property is now required
          Breaking
        • id, name, users properties Modified
          • Properties are now required
            Breaking
PUT /public/v1/user-groups/{userGroupId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, name properties Modified
        • Properties are now required
          Breaking
      • users property Modified
        • Property is now required
          Breaking
        • id, firstName, lastName, email, phoneNumber, title, lastLogin, loginCount, role, ssoUser, reportingRestricted properties Modified
          • Properties are now required
            Breaking
PUT /public/v1/users/{userId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, firstName, lastName, email, phoneNumber, title, lastLogin, loginCount, role, ssoUser, reportingRestricted properties Modified
        • Properties are now required
          Breaking
8 structure changes including:
8 Modifications
Modified 8 Breaking
GET /public/v1/projects/{projectId}/rfis
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • Property is now required
          Breaking
        • projectId property Modified
          • Property is now required
            Breaking
        • rfiLinkedActivities property Modified
GET /public/v1/projects/{projectId}/rfis/{rfiId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • Property is now required
          Breaking
        • projectId property Modified
          • Property is now required
            Breaking
        • rfiLinkedActivities property Modified
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /public/v1/projects/{projectId}/rfis
  • Body
  • application/json content type Modified
    • Rfi property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • Property is now required
          Breaking
        • projectId property Modified
          • Property is now required
            Breaking
        • rfiLinkedActivities property Modified
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Removed
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
PUT /public/v1/projects/{projectId}/rfis/{rfiId}
  • Body
  • application/json content type Modified
    • Rfi property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • rfi property Modified
        • Property is now required
          Breaking
        • projectId property Modified
          • Property is now required
            Breaking
        • rfiLinkedActivities property Modified
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalLinkedActivities, submittalResponses properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /public/v1/projects
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, initialProjectId, startDate, originalScenarioId, underConstruction, projectPlanSlotCount, companyId, source, dataDate properties Modified
        • Permission is now readOnly
        • Properties are now required
          Breaking
      • name, country, city, state, zipcode, latitude, longitude, defaultScenarioId, projectPlanId, weatherStationId, metadata, status, currentModelId, currentModelName properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, initialProjectId, startDate, originalScenarioId, underConstruction, projectPlanSlotCount, companyId, source, dataDate properties Modified
        • Permission is now readOnly
        • Properties are now required
          Breaking
      • name, country, city, state, zipcode, latitude, longitude, defaultScenarioId, projectPlanId, weatherStationId, metadata, status, currentModelId, currentModelName properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/latest
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, initialProjectId, startDate, originalScenarioId, underConstruction, projectPlanSlotCount, companyId, source, dataDate properties Modified
        • Permission is now readOnly
        • Properties are now required
          Breaking
      • name, country, city, state, zipcode, latitude, longitude, defaultScenarioId, projectPlanId, weatherStationId, metadata, status, currentModelId, currentModelName properties Modified
        • Properties are now required
          Breaking
PUT /public/v1/projects/{projectId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • id, initialProjectId, startDate, originalScenarioId, underConstruction, projectPlanSlotCount, companyId, source, dataDate properties Modified
        • Permission is now readOnly
        • Properties are now required
          Breaking
      • name, country, city, state, zipcode, latitude, longitude, defaultScenarioId, projectPlanId, weatherStationId, metadata, status, currentModelId, currentModelName properties Modified
        • Properties are now required
          Breaking
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is no longer object
        Breaking
      • SubmittalResponse property Removed
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalResponses, submittalLinkedActivities properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is no longer object
        Breaking
      • SubmittalResponse property Removed
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Removed
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalLinkedActivities, submittalResponses properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
5 structure changes including:
1 Breaking change
4 Modifications
1 Removal
Modified 4 Breaking
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is no longer object
        Breaking
      • SubmittalResponse property Removed
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalResponses, submittalLinkedActivities properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is no longer object
        Breaking
      • SubmittalResponse property Removed
Removed 1 Breaking
Api keyauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Removed
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalLinkedActivities, submittalResponses properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
16 structure changes including:
11 Breaking changes
4 Modifications
12 Removals
Modified 4 Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/activities
  • Operation is now deprecated
  • Path went from /public/v2/projects/{projectId}/scenarios/{scenarioId}/activities to /public/v1/projects/{projectId}/scenarios/{scenarioId}/activities (same operationId)
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/percent-complete-curve
  • Operation is now deprecated
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/schedules
  • Operation is now deprecated
GET /public/v2/projects/{projectId}/scenarios/{scenarioId}/activities
  • Path went from /public/v2/projects/{projectId}/scenarios/{scenarioId}/activities/filter-activities to /public/v2/projects/{projectId}/scenarios/{scenarioId}/activities (same operationId)
    Breaking
  • Verb went from POST to GET (same operationId)
    Breaking
  • Body
  • application/json content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • dataDate, filterId, activityCodeFilter, includeDeleted query parameters Added
Removed 12 Breaking
DELETE /public/v1/projects/{projectId}/models/**
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /public/v1/company/{companyId}/projects-export
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /public/v1/projects/{projectId}/models/**
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /public/v1/projects/{projectId}/rfis/rfi-export
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/activities
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/schedule-quality-export
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
HEAD /public/v1/projects/{projectId}/models/**
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
OPTIONS /public/v1/projects/{projectId}/models/**
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /public/v1/projects/{projectId}/models/**
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /public/v1/projects/{projectId}/models/**
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /public/v1/projects/{projectId}/scenarios/{scenarioId}/activities/filter-activities
PUT /public/v1/projects/{projectId}/models/**
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
2 structure changes including:
2 Modifications
Modified 2
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/activities
  • Operation is now deprecated
POST /public/v1/projects/{projectId}/scenarios/{scenarioId}/activities/filter-activities
  • Operation is now deprecated
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is no longer object
        Breaking
      • SubmittalResponse property Removed
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalResponses, submittalLinkedActivities properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is no longer object
        Breaking
      • SubmittalResponse property Removed
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /public/v1/me
  • Response
  • 200 response Modified
    • */* content type Modified
      • firstName, lastName, email, title properties Modified
        • Properties are now required
          Breaking
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Removed
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalLinkedActivities, submittalResponses properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
8 structure changes including:
8 Breaking changes
8 Removals
Removed 8 Breaking
DELETE /public/v1/projects/{projectId}/activity-code-type-mappings/{activityCodeTypeMappingId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /public/v1/projects/{projectId}/activity-code-type-mappings
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /public/v1/projects/{projectId}/activity-code-type-mappings/mapping-type/{activityCodeTypeMappingType}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /public/v1/projects/{projectId}/activity-code-type-mappings/{activityCodeTypeMappingId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/activityCodes/{activityCodeId}/activity-code-health-index
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /public/v1/projects/{projectId}/scenarios/{scenarioId}/activityCodes/{activityCodeId}/changes-impact-score
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /public/v1/projects/{projectId}/activity-code-type-mappings
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /public/v1/projects/{projectId}/activity-code-type-mappings/{activityCodeTypeMappingId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Added
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is no longer object
        Breaking
      • SubmittalResponse property Removed
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalResponses, submittalLinkedActivities properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is no longer object
        Breaking
      • SubmittalResponse property Removed
6 structure changes including:
2 Breaking changes
4 Modifications
2 Removals
Modified 4 Breaking
GET /public/v1/projects/{projectId}/submittals
  • Response
  • 200 response Modified
    • */* content type Modified
GET /public/v1/projects/{projectId}/submittals/{submittalId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • submittal property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /public/v1/projects/{projectId}/submittals
  • Body
  • application/json content type Modified
    • Submittal property Removed
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
PUT /public/v1/projects/{projectId}/submittals/{submittalId}
  • Body
  • application/json content type Modified
    • submittalLinkedActivities, submittalResponses properties Modified
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type is now object
      • SubmittalResponse property Added
Removed 2 Breaking
POST /public/v1/me/change-password
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /public/v1/me
  • Removing a resource is always breaking unless it was deprecated before
    Breaking