DHTMLX Planning Engine Documentation

types#

These pages describe the JSON payloads that more than one export reads or returns. ProjectData and its records go into schedule, solve and analyze. SchedulingChanges goes into preview and apply. ScheduleResult comes back from schedule, solve, preview and analyze. The other pages cover options, the load profile, metrics and slots.

Shared scalars and enums, such as Id, DateValue and TimeUnit, are on Common. A payload that only one call uses is documented on that call's page. Field spelling, null handling and the result envelope are covered in Wire format.

  • AssignmentDataAn assignment record that books a resource on a task, whole or as a slice of the task's work
  • CalendarDataA working calendar in ProjectData.calendars, with its hours, weekdays and date exceptions
  • Common typesIds, dates, enum values and small shapes shared by several payloads
  • LevelingOptionsOptions of a leveling run, sent as options_json of level and as the level field of evaluate and suggestAssignments options
  • LinkDataA dependency between two tasks in the links array of project data
  • LoadProfilePer-bucket load and capacity of resources, returned by loadProfile and by preview with a profile query
  • MetricsScores of one plan state (finish, overload, conflicts, cycles and cost) returned by evaluate and suggestAssignments
  • ProjectDataThe full project snapshot passed as data_json to schedule, solve and analyze
  • OverallocationThe overallocation windows of one resource in a scheduling or leveling result
  • ScheduleResultResponse payload of schedule, solve, preview and analyze - updates, cycles, conflicts, notes and optional analytics, load and profile data
  • SchedulingChangesA change set for a live project, with add, update and remove lists for tasks, links, resources and assignments
  • SchedulingConfigProject-wide scheduling switches, sent as the config field of ProjectData
  • SlotOne requirement instance on one task, with the resources allowed to fill it
  • SolveOptionsOptions passed as options_json to schedule and solve, choosing the scope and what the result reports
  • TaskDataOne task record in project data or in a change set's add list
  • TaskUpdateA partial edit of an existing task in a change set's update list