Schedules API

The Schedules API provides cloud access to 4D construction schedule data. A schedule describes the planned sequence of work on a construction project — the tasks to be performed, when they happen, and the resources needed to carry them out. With this API, you can work with your schedules directly through the cloud.

A schedule is linked with an iModel, allowing you to animate construction progress in 3D as the schedule advances. The Schedules API provides the animation data, such as bindings between tasks and iModel elements and endpoints that describe how to animate the iModel.

Schedule types

• v65 schedules — schedules authored with the SYNCHRO 4D PRO desktop application. These are primarily intended for reading data via the cloud, with a limited set of POST workflows available. v65 schedules rely on synchronizations to bring the latest data into the cloud. The data you see reflects the most recent successful synchronization.
• v10 schedules — cloud-native schedules. They allow you to easily read and modify schedule data directly through the API, without requiring synchronizations.

Set up a v65 schedule

1. Go to the Bentley Infrastructure Cloud website.
2. Register a new project or open an existing one.
3. Open the new project and create an iModel.
4. Check Use this iModel for scheduling services.
5. Optionally, upload an .sp file.
6. Wait for initial synchronization to succeed.
7. The v65 schedule should now be accessible through this API.

Set up a v10 schedule

1. Set up an iModel using the iModels API.
2. POST a new schedule for that iModel. This creates a schedule with default entities.
3. You can now read and modify the schedule freely.

Long-running operations workflow

This API contains endpoints that use long-running operations. For such endpoints, use the following workflow:

1. Submit the change — send a POST request to an endpoint, which returns an operation.
2. Track the operation — the response includes an operation reference (see the Operation-Location header). Poll the operation endpoint to monitor progress.
3. Completion — once the operation completes, the service applies the changes.