types#

These pages describe the plain objects that more than one call takes or returns. ProjectData and its records go into solve, analyze and schedule. SchedulingChanges goes into preview and apply, and comes back from suggestAssignments. ScheduleResult is what solve, preview, analyze and schedule return. The other pages cover options, the load profile, metrics, slots and the error classes.

Small shared types, such as Id, DateValue and TimeUnit, are on Common. An options or result shape that only one call uses is documented on that call's page. For how dates and plain objects behave in inputs and results, see Plain objects and dates.

• AssignmentDataA resource booked on a task, optionally for a slice of the task's work
• CalendarDataA named working-time calendar that tasks and resources reference by id
• Common typesIds, dates, units, constraint types and small shapes shared by several calls
• ErrorsInputError, ProjectError and the other errors thrown by Project methods and schedule
• LevelingOptionsOptions for resource leveling - scope, bucket basis, selection order, slack cap, splits and step size
• LinkDataA dependency between two tasks, with its type and lag
• LoadProfilePer-bucket load and capacity of resources over a date range, for drawing a resource histogram
• MetricsFinish, overload, conflict and cycle measures of one scored state, with a cost for ranking
• OverallocationThe overallocated time windows of one resource in a schedule result
• ProjectDataThe plain object that holds a whole plan as input for solve, analyze and schedule
• ScheduleResultThe result of a scheduling call, with changed task dates, problems found in the plan and optional analytics
• SchedulingChangesOne set of edits to a live project, grouped into task, link, resource and assignment buckets, with an optional baseline check
• SchedulingConfigProject-wide scheduling settings carried in ProjectData.config
• SlotOne requirement instance on one task, with its eligible resources and the assignment filling it
• SolveOptionsOptions for Project#solve and schedule - scope, analytics, reasons and full date lists
• TaskDataOne task, summary or milestone as a plain input object
• TaskUpdateA partial task record that edits one existing task inside a change set