Change Updates

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

10 days ago

main
1.0.0
Compare

API structure has changed

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