• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Start Free
    Table of contents
    Overview
    Samples
    Changelog
    Schedules
    Download API definition:

    API references

    Call
    Request URL
    Title
    Tags
    POST
    /schedules/{scheduleId}/appearance-profiles
    Create Appearance Profile
    Appearance Profiles
    POST
    /schedules/{scheduleId}/calendars
    Create Calendar
    Calendars
    POST
    /schedules/{scheduleId}/entities-3d/user-field-values
    Create Entity 3D User Field Values
    Entities 3D
    POST
    /schedules/{scheduleId}/resources
    Create Resource
    Resources
    POST
    /schedules/{scheduleId}/resource-groups/user-field-values
    Create Resource Group User Field Values
    Resource Groups
    POST
    /schedules/{scheduleId}/resources/status-history
    Create Resource Status History Item
    Resource Status History
    POST
    /schedules/{scheduleId}/resources/user-field-values
    Create Resource User Field Values
    Resources
    POST
    /schedules/{scheduleId}/resources/user-field-values/batch
    Create Resource User Field Values
    Resources
    POST
    /schedules/{scheduleId}/resources/batch
    Create Resources
    Resources
    POST
    /schedules/
    Create Schedule
    Schedules
    POST
    /schedules/{scheduleId}/tasks
    Create Task
    Tasks
    POST
    /schedules/{scheduleId}/task-links/batch
    Create Task Links
    Task Links
    POST
    /schedules/{scheduleId}/task-query-filters
    Create Task Query Filter
    Task Query Filters
    POST
    /schedules/{scheduleId}/tasks/resource-assignments
    Create Task Resource Assignment
    Tasks
    POST
    /schedules/{scheduleId}/tasks/resource-assignments/batch
    Create Task Resource Assignments
    Tasks
    POST
    /schedules/{scheduleId}/tasks/user-field-values
    Create Task User Field Values
    Tasks
    POST
    /schedules/{scheduleId}/user-fields
    Create User Field
    User Fields
    DELETE
    /schedules/{scheduleId}/appearance-profiles/{appearanceProfileId}
    Delete Appearance Profile
    Appearance Profiles
    DELETE
    /schedules/{scheduleId}/resources?resourceIds={resourceIds}
    Delete Resources
    Resources
    DELETE
    /schedules/{scheduleId}/tasks/{taskId}
    Delete Task
    Tasks
    DELETE
    /schedules/{scheduleId}/task-links?taskLinkIds={taskLinkIds}
    Delete Task Links
    Task Links
    DELETE
    /schedules/{scheduleId}/task-query-filters/{queryFilterId}
    Delete Task Query Filter
    Task Query Filters
    DELETE
    /schedules/{scheduleId}/tasks?taskIds={taskIds}
    Delete Tasks
    Tasks
    DELETE
    /schedules/{scheduleId}/tasks/resource-assignments[?resourceAssignmentIds]
    Delete Tasks Resource Assignments
    Tasks
    GET
    /schedules/{scheduleId}/entities-3d/user-field-values[?entity3dId][&userFieldId][&$top][&$continuationToken]
    Get 3D Entities User Field Values
    Entities 3D
    GET
    /schedules/{scheduleId}/animation-3d-paths/{animation3dPathId}
    Get Animation 3D Path
    Animation 3D Paths
    GET
    /schedules/{scheduleId}/animation-3d-path-assignments/{animation3dPathAssignmentId}
    Get Animation 3D Path Assignment
    Animation 3D Path Assignments
    GET
    /schedules/{scheduleId}/animation-3d-path-assignments[?$top][&$continuationToken][&$deltaToken]
    Get Animation 3D Path Assignments
    Animation 3D Path Assignments
    GET
    /schedules/{scheduleId}/animation-3d-paths/{animation3dPathId}/keyframes[?$top][&$continuationToken][&$deltaToken]
    Get Animation 3D Path Keyframes
    Animation 3D Paths
    GET
    /schedules/{scheduleId}/animation-3d-paths[?$top][&$continuationToken][&$deltaToken]
    Get Animation 3D Paths
    Animation 3D Paths
    GET
    /schedules/{scheduleId}/animation-3d-paths/keyframes[?$top][&$continuationToken][&$deltaToken]
    Get Animation 3D Paths Keyframes
    Animation 3D Paths
    GET
    /schedules/{scheduleId}/animation-3d-transforms/{animation3dTransformId}
    Get Animation 3D Transform
    Animation 3D Transforms
    GET
    /schedules/{scheduleId}/animation-3d-transforms[?$top][&$continuationToken][&$deltaToken]
    Get Animation 3D Transforms
    Animation 3D Transforms
    GET
    /schedules/{scheduleId}/animation-bindings[?$top][&$continuationToken][&startTime][&endTime][&taskIds][&animatedEntityIds]
    Get Animation Bindings
    Animation Bindings
    GET
    /schedules/{scheduleId}/animation-statistics
    Get Animation Statistics
    Animation Bindings
    GET
    /schedules/{scheduleId}/appearance-profiles/{appearanceProfileId}
    Get Appearance Profile
    Appearance Profiles
    GET
    /schedules/{scheduleId}/appearance-profiles[?$top][&$continuationToken][&$deltaToken]
    Get Appearance Profiles
    Appearance Profiles
    GET
    /schedules/{scheduleId}/baselines/{baselineId}
    Get Baseline
    Baselines
    GET
    /schedules/{scheduleId}/baselines/{baselineId}/code-values[?$top][&$continuationToken][&$deltaToken]
    Get Baseline Code Values
    Baselines
    GET
    /schedules/{scheduleId}/baselines/{baselineId}/baseline-task-links[?$top][&$continuationToken][&$deltaToken]
    Get Baseline Task Links
    Baseline Task Links
    GET
    /schedules/{scheduleId}/baselines/{baselineId}/baseline-tasks[?$top][&$continuationToken][&$deltaToken]
    Get Baseline Tasks
    Baseline Tasks
    GET
    /schedules/{scheduleId}/baselines/{baselineId}/baseline-tasks/scheduling-analyses[?$top][&$continuationToken][&$deltaToken]
    Get Baseline Tasks Scheduling Analyses
    Baseline Tasks
    GET
    /schedules/{scheduleId}/baselines[?$top][&$continuationToken][&$deltaToken]
    Get Baselines
    Baselines
    GET
    /schedules/{scheduleId}/baselines/code-value-assignments[?baselineId][&codeValueId][&$top][&$continuationToken][&$deltaToken]
    Get Baselines Code Value Assignments
    Baselines
    GET
    /schedules/{scheduleId}/baselines/baseline-task-links[?baselineId][&taskLinkId][&predecessorId][&successorId][&$top][&$continuationToken][&$deltaToken]
    Get Baselines Task Links
    Baseline Task Links
    GET
    /schedules/{scheduleId}/baselines/baseline-tasks[?baselineId][&taskId][&$top][&$continuationToken][&$deltaToken]
    Get Baselines Tasks
    Baseline Tasks
    GET
    /schedules/{scheduleId}/baselines/baseline-tasks/scheduling-analyses[?baselineId][&taskId][&$top][&$continuationToken][&$deltaToken]
    Get Baselines Tasks Scheduling Analyses
    Baseline Tasks
    GET
    /schedules/{scheduleId}/calendars/{calendarId}
    Get Calendar
    Calendars
    GET
    /schedules/{scheduleId}/calendars[?$top][&$continuationToken][&$deltaToken]
    Get Calendars
    Calendars
    GET
    /schedules/{scheduleId}/codes/{codeId}
    Get Code
    Codes
    GET
    /schedules/{scheduleId}/codes/{codeId}/code-values[?$top][&$continuationToken][&$deltaToken]
    Get Code Code Values
    Codes
    GET
    /schedules/{scheduleId}/code-values/{codeValueId}
    Get Code Value
    Code Values
    GET
    /schedules/{scheduleId}/code-values[?name][&codeId][&parentId][&$top][&$continuationToken][&$deltaToken]
    Get Code Values
    Code Values
    GET
    /schedules/{scheduleId}/codes[?name][&$top][&$continuationToken][&$deltaToken]
    Get Codes
    Codes
    GET
    /schedules/{scheduleId}/tasks/critical-path[?$top][&$continuationToken]
    Get Critical Path Tasks
    Tasks
    GET
    /schedules/{scheduleId}/entities-3d[?name][&parentId][&iModelElementId][&$top][&$continuationToken]
    Get Entities 3D
    Entities 3D
    GET
    /schedules/{scheduleId}/entities-3d/{entity3dId}
    Get Entity 3D
    Entities 3D
    GET
    /schedules/{scheduleId}/entities-3d/{entity3dId}/user-field-values[?$top][&$continuationToken]
    Get Entity 3D User Field Values
    Entities 3D
    GET
    /schedules/{scheduleId}/imports/microsoft-project/synchronizers/{synchronizerId}
    Get Microsoft Project Synchronizer
    Imports
    GET
    /schedules/{scheduleId}/operations/{operationId}
    Get Operation
    Operations
    GET
    /schedules/{scheduleId}/imports/primavera/synchronizers/{synchronizerId}
    Get Primavera Synchronizer
    Imports
    GET
    /schedules/{scheduleId}/project-scheduling
    Get Project Scheduling
    Project
    GET
    /schedules/{scheduleId}/resources/{resourceId}
    Get Resource
    Resources
    GET
    /schedules/{scheduleId}/resources/{resourceId}/code-values[?$top][&$continuationToken][&$deltaToken]
    Get Resource Code Values
    Resources
    GET
    /schedules/{scheduleId}/resources/{resourceId}/entities-3d[?$top][&$continuationToken]
    Get Resource Entities 3D
    Resources
    GET
    /schedules/{scheduleId}/resource-groups/{resourceGroupId}
    Get Resource Group
    Resource Groups
    GET
    /schedules/{scheduleId}/resource-groups/{resourceGroupId}/code-values[?$top][&$continuationToken][&$deltaToken]
    Get Resource Group Code Values
    Resource Groups
    GET
    /schedules/{scheduleId}/resource-groups/{resourceGroupId}/user-field-values[?$top][&$continuationToken][&$deltaToken]
    Get Resource Group User Field Values
    Resource Groups
    GET
    /schedules/{scheduleId}/resource-groups[?name][&plannerResourceId][&superintendentResourceId][&foremanResourceId][&generalForemanResourceId][&$top][&$continuationToken]
    Get Resource Groups
    Resource Groups
    GET
    /schedules/{scheduleId}/resource-groups/code-value-assignments[?resourceGroupId][&codeValueId][&$top][&$continuationToken][&$deltaToken]
    Get Resource Groups Code Value Assignments
    Resource Groups
    GET
    /schedules/{scheduleId}/resource-groups/{resourceGroupId}/resources[?$top][&$continuationToken]
    Get Resource Groups Resources
    Resource Groups
    GET
    /schedules/{scheduleId}/resource-groups/user-field-values[?resourceGroupId][&userFieldId][&$top][&$continuationToken][&$deltaToken]
    Get Resource Groups User Field Values
    Resource Groups
    GET
    /schedules/{scheduleId}/resource-status-categories[?name][&$top][&$continuationToken][&$deltaToken]
    Get Resource Status Categories
    Resource Status Categories
    GET
    /schedules/{scheduleId}/resource-status-categories/{resourceStatusCategoryId}
    Get Resource Status Category
    Resource Status Categories
    GET
    /schedules/{scheduleId}/resource-status-categories/{resourceStatusCategoryId}/resource-status-sets[?$top][&$continuationToken][&$deltaToken]
    Get Resource Status Category Sets
    Resource Status Categories
    GET
    /schedules/{scheduleId}/resources/{resourceId}/status-history[?categoryIds][&isLatest][&$top][&$continuationToken]
    Get Resource Status History
    Resource Status History
    GET
    /schedules/{scheduleId}/resources/status-history/{statusHistoryItemId}
    Get Resource Status History Item
    Resource Status History
    GET
    /schedules/{scheduleId}/resource-status-items/{resourceStatusItemId}
    Get Resource Status Item
    Resource Status Items
    GET
    /schedules/{scheduleId}/resource-status-items[?name][&statusSetId][&$top][&$continuationToken][&$deltaToken]
    Get Resource Status Items
    Resource Status Items
    GET
    /schedules/{scheduleId}/resource-status-sets/{resourceStatusSetId}
    Get Resource Status Set
    Resource Status Sets
    GET
    /schedules/{scheduleId}/resource-status-sets/{resourceStatusSetId}/resource-status-items[?$top][&$continuationToken][&$deltaToken]
    Get Resource Status Set Items
    Resource Status Sets
    GET
    /schedules/{scheduleId}/resource-status-sets[?name][&statusCategoryId][&$top][&$continuationToken][&$deltaToken]
    Get Resource Status Sets
    Resource Status Sets
    GET
    /schedules/{scheduleId}/resources/{resourceId}/user-field-values[?$top][&$continuationToken][&$deltaToken]
    Get Resource User Field Values
    Resources
    GET
    /schedules/{scheduleId}/resources[?$top][&$continuationToken][&$deltaToken]
    Get Resources
    Resources
    GET
    /schedules/{scheduleId}/resources/code-value-assignments[?resourceId][&codeValueId][&$top][&$continuationToken][&$deltaToken]
    Get Resources Code Value Assignments
    Resources
    GET
    /schedules/{scheduleId}/resources/entity-3d-assignments[?resourceId][&entity3dId][&$top][&$continuationToken]
    Get Resources Entity 3D Assignments
    Resources
    GET
    /schedules/{scheduleId}/resources/status-history[?resourceId][&categoryIds][&taskId][&isLatest][&$top][&$continuationToken]
    Get Resources Status History
    Resource Status History
    GET
    /schedules/{scheduleId}/resources/user-field-values[?resourceId][&userFieldId][&$top][&$continuationToken][&$deltaToken]
    Get Resources User Field Values
    Resources
    GET
    /schedules/{scheduleId}
    Get Schedule
    Schedules
    GET
    /schedules/?iTwinId={iTwinId}[&$top][&$continuationToken]
    Get Schedules
    Schedules
    GET
    /schedules/{scheduleId}/tasks/{taskId}
    Get Task
    Tasks
    GET
    /schedules/{scheduleId}/tasks/{taskId}/code-values[?$top][&$continuationToken][&$deltaToken]
    Get Task Code Values
    Tasks
    GET
    /schedules/{scheduleId}/task-links/{taskLinkId}
    Get Task Link
    Task Links
    GET
    /schedules/{scheduleId}/task-links[?predecessorId][&successorId][&$top][&$continuationToken][&$deltaToken]
    Get Task Links
    Task Links
    GET
    /schedules/{scheduleId}/task-query-filters/{queryFilterId}
    Get Task Query Filter
    Task Query Filters
    GET
    /schedules/{scheduleId}/task-query-filters[?name][&version][&createdBy][&$top][&$continuationToken][&$deltaToken]
    Get Task Query Filters
    Task Query Filters
    GET
    /schedules/{scheduleId}/tasks/{taskId}/resource-assignments[?$top][&$continuationToken][&$deltaToken]
    Get Task Resource Assignments
    Tasks
    GET
    /schedules/{scheduleId}/tasks/scheduling-analyses[?$top][&$continuationToken][&$deltaToken]
    Get Task Scheduling Analyses
    Tasks
    GET
    /schedules/{scheduleId}/tasks/{taskId}/scheduling-analysis
    Get Task Scheduling Analysis
    Tasks
    GET
    /schedules/{scheduleId}/task-statuses/{taskStatusId}
    Get Task Status
    Task Statuses
    GET
    /schedules/{scheduleId}/task-statuses[?name][&$top][&$continuationToken][&$deltaToken]
    Get Task Statuses
    Task Statuses
    GET
    /schedules/{scheduleId}/tasks/{taskId}/user-field-values[?$top][&$continuationToken][&$deltaToken]
    Get Task User Field Values
    Tasks
    GET
    /schedules/{scheduleId}/tasks[?$top][&$continuationToken][&$deltaToken][&calendarId]
    Get Tasks
    Tasks
    GET
    /schedules/{scheduleId}/tasks/code-value-assignments[?taskId][&codeValueId][&$top][&$continuationToken][&$deltaToken]
    Get Tasks Code Value Assignments
    Tasks
    GET
    /schedules/{scheduleId}/tasks/resource-assignments[?taskId][&resourceId][&$top][&$continuationToken][&$deltaToken]
    Get Tasks Resource Assignments
    Tasks
    GET
    /schedules/{scheduleId}/tasks/user-field-values[?taskId][&userFieldId][&$top][&$continuationToken][&$deltaToken]
    Get Tasks User Field Values
    Tasks
    GET
    /schedules/{scheduleId}/user-fields/{userFieldId}
    Get User Field
    User Fields
    GET
    /schedules/{scheduleId}/user-fields[?name][&$top][&$continuationToken][&$deltaToken]
    Get User Fields
    User Fields
    POST
    /schedules/{scheduleId}/imports/microsoft-project
    Import Uploaded Microsoft Project File
    Imports
    POST
    /schedules/{scheduleId}/imports/primavera
    Import Uploaded Primavera File
    Imports
    PATCH
    /schedules/{scheduleId}/appearance-profiles/{appearanceProfileId}
    Patch Appearance Profile
    Appearance Profiles
    PATCH
    /schedules/{scheduleId}/tasks/{taskId}
    Patch Task
    Tasks
    PATCH
    /schedules/{scheduleId}/tasks/resource-assignments
    Patch Tasks Resource Assignments
    Tasks
    POST
    /schedules/{scheduleId}/tasks/reschedule
    Reschedule Tasks
    Tasks
    POST
    /schedules/{scheduleId}/files
    Start File Upload
    Files
    POST
    /schedules/{scheduleId}/imports/microsoft-project/synchronize
    Synchronize Uploaded Microsoft Project File
    Imports
    POST
    /schedules/{scheduleId}/imports/primavera/synchronize
    Synchronize Uploaded Primavera File
    Imports
    PATCH
    /schedules/{scheduleId}/task-links
    Update Task Links
    Task Links
    PUT
    /schedules/{scheduleId}/task-query-filters/{queryFilterId}
    Update Task Query Filter
    Task Query Filters
    PATCH
    /schedules/{scheduleId}/files/{fileId}
    Upload File Chunk
    Files

    Was this page helpful?