1. P6 EPPM Rest API
  2. Tasks
  3. ScheduleOptions

Read ScheduleOptions

get

/scheduleOptions

Reads ScheduleOptions objects from the database.

Request

Query Parameters
Header Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : List<ScheduleOptions>
Type: array
Title: List<ScheduleOptions>
Show Source
Nested Schema : ScheduleOptions
Type: object
Title: ScheduleOptions
ScheduleOptions Entity
Show Source
  • The flag that indicates how each activity's float will be calculated with respect to other projects in the scheduling batch. This setting only has an effect when scheduling multiple projects at the same time. If true, each activity's float is calculated based on its project's ScheduledFinishDate. If false, then each activity's float is calculated based on the latest ScheduledFinishDate of all of the projects in the scheduling batch.
  • The method for calculating total float for all activities. Start Float is the difference between the early and late start dates (Start Float = Late Start - Early Start); Finish Float is the difference between the early and late finish dates (Finish Float = Late Finish - Early Finish); and Smallest of Start Float and Finish Float is the most critical float value.
  • The date this schedule option was created.
  • The name of the user that created this schedule option.
  • The maximum float time for activities before they are marked critical.
  • The critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.
  • The option used by the scheduler for treating activity relationships between projects when scheduling.
  • The date this schedule option was last updated.
  • The name of the user that last updated this schedule option.
  • The option used by the scheduler for automatically leveling resources when scheduling projects.
  • The number of critical float paths to calculate. For example, if you set the field to five, the module calculates the five most critical float paths ending with the activity you selected. The module ranks each float path from most critical to least critical, and stores the value for each activity in the Float Path field. For example, if you calculate five float paths, the module will store a value of one in the Float Path field for each activity in the most critical float path; the module will store a value of five for each activity in the least critical float path. Note: To view the critical float paths after you schedule the project, group activities in the Activity Table by Float Path and sort by Float Path Order. A Float Path value of one indicates that those activities are part of the most critical float path. The Float Path Order value indicates the order in which the activities were processed.
  • The Boolean value that indicates whether multiple critical float paths (sequences of activities) should be calculated in the project schedule.
  • The activity in the WBS that you want to represent the end of the float paths. Typically, this will be a milestone activity or some other significant activity that has a start date or end date that cannot change. Note: if a value is not assigned, the module will choose an activity based on MultipleFloatPathsUseTotalFloat. If you are calculating multiple paths using Free Float, the module will choose the open-ended activity with the most critical Free Float. If you are calculating multiple paths using Total Float, the module will calculate the Total Float for all activity relationships, then choose the activity with the most critical Relationship Total Float.
  • The Boolean value that decides whether or not to use total float in multiple float path calculations.If True, then based on the activity you want the paths to end on, the module determines which predecessor activity has the most critical Relationship Total Float on the backward pass. The module repeats this process until an activity is reached that has no relationship. The module begins the forward pass from this activity and determines which successor activity has the most critical Relationship Successor Total Float. The module repeats this process until an activity is reached that has no relationship. These activities represent the most critical float path. The process begins again until the remaining sub-critical paths are calculated.If False, then critical float paths are defined based on longest path. The most critical path will be identical to the critical path that is derived when you choose to define critical activities as Longest Path in the General tab. In a multicalendar project, the longest path is calculated by identifying the activities that have an early finish equal to the latest calculated early finish for the project and tracing all driving relationships for those activities back to the project start date. After the most critical path is identified, the module will calculate the remaining sub-critical paths.
  • The type of logic used to schedule the progressed activities: 'Retained Logic', 'Progress Override', or 'Actual Dates'.
  • The short code that uniquely identifies the project.
  • The unique ID of the associated project.
  • The calendar used to calculate the lag between predecessors and successors for all activities. Valid values are 'Predecessor Activity Calendar', 'Successor Activity Calendar', '24 Hour Calendar', and 'Project Default Calendar'. If you do not select a calendar, the successor activity calendar is used.
  • he method used to calculate lag when a start-to-start relationship exists and the predecessor starts out of sequence. Actual Start sets the successor's start according to the time elapsed from the predecessor's actual start (the successor's start date is the data date plus any remaining lag). Early Start sets the successor's start according to the amount of work that the predecessor activity accomplishes (the expired lag is calculated as the number of work periods between the actual start and the data date, and the successor's start date is the predecessor's internal early start plus any remaining lag).
  • The option used for setting activity finish dates as the expected finish dates when scheduling projects.
  • The user's login name.
  • The unique ID of the associated user.

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.
Back to Top