Skip to navigation
Developer's GuideBIM 360 Compatibility

BIM 360 Forward-Compatible Endpoints

View as Markdown

In order to enable your current BIM 360 apps and integrations to be compatible with Forma projects, we have ensured that many BIM 360 endpoints are forward compatible with Forma. This makes it possible for you to access Forma projects and use your BIM 360 apps and integrations before new Forma APIs are available. Note that your existing apps and integrations to BIM 360 and PlanGrid will continue to function as-is for the foreseeable future.

The following tables list all the BIM 360 endpoints and indicate whether they are compatible or not compatible with Forma projects.

Assets API

APIEndpointForward Compatible
AssetsGET assetsYes
POST assets:batch-getYes
POST assets:batch-createYes
PATCH assets:batch-patchYes
POST assets:batch-deleteYes
GET categoriesYes
POST categories:batch-getYes
POST categoriesYes
POST status-step-setsYes
POST status-step-sets:batch-getYes
GET status-step-setsYes
POST category-status-step-sets/status-step-sets:batch-getYes
PUT categories/:categoryId/status-step-set/:statusStepSetIdYes
POST asset-statusesYes
POST asset-statuses:batch-getYes
GET asset-statusesYes
POST custom-attributesYes
POST custom-attributes:batch-getYes
GET custom-attributesYes
PATCH custom-attributes/:customAttributeIdYes
GET categories/:categoryId/custom-attributesYes
PUT categories/:categoryId/custom-attributes/:customAttributeIdYes
POST assets/:assetId/relationshipsYes
POST categories/:categoryId/relationshipsYes
POST relationships:deleteYes
GET error-codesYes
GET error-codes/:errorCodeNameYes

Checklists API

APIEndpointForward Compatible
ChecklistsGET instancesNo
GET instances/:idNo
GET templatesNo
GET templates/:idNo

Cost API

APIEndpointForward Compatible
CostGET actionsYes
POST actionsYes
GET attachmentsYes
POST attachmentsYes
DELETE attachments/:attachmentIdYes
POST attachment-foldersYes
GET budgetsYes
POST budgetsYes
POST budgets:importYes
DELETE budgets/:budgetIdYes
PATCH budgets/:budgetIdYes
GET budgets/:budgetIdYes
GET change-ordersYes
GET change-orders/:changeOrderYes
POST change-orders/:changeOrderYes
GET change-orders/:changeOrder/:idYes
PATCH change-orders/:changeOrder/:idYes
DELETE change-orders/:changeOrder/:idYes
DELETE contracts/:contractIdYes
GET contracts/:contractIdYes
PATCH contracts/:contractIdYes
GET contractsYes
POST contractsYes
GET cost-itemsYes
POST cost-itemsYes
GET cost-items/:costItemIdYes
PATCH cost-items/:costItemIdYes
DELETE cost-items/:costItemIdYes
POST cost-items:attachYes
POST cost-items:detachYes
GET documentsYes
GET expensesYes
POST expensesYes
GET expenses/:idYes
PATCH expenses/:idYes
DELETE expenses/:idYes
GET expenses/:expenseId/itemsYes
POST expenses/:expenseId/itemsYes
GET expenses/:expenseId/items/:idYes
PATCH expenses/:expenseId/items/:idYes
DELETE expenses/:expenseId/items/:idYes
GET main-contractsYes
POST main-contractsYes
GET main-contracts/:idYes
PATCH main-contracts/:idYes
DELETE main-contracts/:idYes
GET main-contracts/:mainContractId/itemsYes
POST main-contracts/:mainContractId/itemsYes
GET main-contracts/:mainContractId/items/:idYes
PATCH main-contracts/:mainContractId/items/:idYes
DELETE main-contracts/:mainContractId/items/:idYes
GET paymentsYes
GET payments/:idYes
GET payment-itemsYes
GET performance-tracking-itemsYes
POST performance-tracking-itemsYes
GET performance-tracking-items/:idYes
DELETE performance-tracking-items/:idYes
GET performance-tracking-item-instancesYes
POST performance-tracking-item-instancesYes
GET performance-tracking-item-instances/:idYes
PATCH performance-tracking-item-instances/:idYes
DELETE performance-tracking-item-instances/:idYes
GET propertiesYes
POST property-values:batch-updateYes
GET schedule-of-valuesYes
POST schedule-of-valuesYes
GET schedule-of-values/:idYes
PATCH schedule-of-values/:idYes
DELETE schedule-of-values/:idYes
GET segmentsYes
POST segmentsYes
DELETE segmentsYes
PATCH segmentsYes
GET segmentsYes
GET templatesYes
GET time-sheetsYes
POST time-sheetsYes
GET time-sheets/:idYes
PATCH time-sheets/:idYes
DELETE time-sheets/:idYes
GET valuesYes
POST valuesYes
POST values:importYes
DELETE values/:valueIdYes
PATCH values/:valueIdYes
GET values/:valueIdYes
POST sub-cost-itemsYes
GET sub-cost-itemsYes
PATCH sub-cost-items/:subCostItemsIdYes
DELETE sub-cost-items/:subCostItemsIdYes
POST subCostItems:copyYes

Data Connector API

Document Management (Files) API

APIEndpointForward Compatible
Document ManagementPOST projects/:project_id/versions/:version_id/exportsNo**
GET projects/:project_id/versions/:version_id/exports/:export_idNo**
POST projects/:project_id/folders/:folder_id/permissions:batch-createYes*
POST projects/:project_id/folders/:folder_id/permissions:batch-updateYes*
POST projects/:project_id/folders/:folder_id/permissions:batch-deleteYes*
GET projects/:project_id/folders/:folder_id/permissionsYes*
POST versions:batch-getYes*
GET custom-attribute-definitionsYes*
POST custom-attribute-definitionsYes*
POST custom-attributes:batch-updateYes*
GET naming-standardsYes*
Data ManagementGET hubsYes*
GET hubs/:hub_idYes*
GET hubs/:hub_id/projectsYes*
GET hubs/:hub_id/projects/project_idYes*
GET hubs/:hub_id/projects/topFoldersYes*
GET projects/:project_id/downloads/:download_idNo
GET projects/:project_id/jobs/:job_idNo
POST projects/:project_id/downloadsNo
POST projects/:project_id/storageYes*
GET projects/:project_id/folders/:folder_idYes*
GET projects/:project_id/folders/:folder_id/contentsYes*
GET projects/:project_id/folders/:folder_id/parentYes*
GET projects/:project_id/folders/:folder_id/refsYes*
GET projects/:project_id/folders/:folder_id/relationships/linksYes*
GET projects/:project_id/folders/:folder_id/relationships/refsYes*
GET projects/:project_id/folders/:folder_id/searchYes*
POST projects/:project_id/foldersYes*
POST projects/:project_id/folders/:folder_id/relationships/refsNo
PATCH projects/:project_id/folders/:folder_idYes*
GET projects/:project_id/items/:item_idYes*
GET projects/:project_id/items/:item_id/parentYes*
GET projects/:project_id/items/:item_id/refsYes*
GET projects/:project_id/items/:item_id/relationships/linksYes*
GET projects/:project_id/items/:item_id/relationships/refsYes*
GET projects/:project_id/items/:item_id/tipYes*
GET projects/:project_id/items/:item_id/versionsYes*
POST projects/:project_id/itemsYes*
POST projects/:project_id/items/:item_id/relationships/refsNo*
PATCH projects/:project_id/items/:item_idYes*
GET projects/:project_id/versions/:version_idYes*
GET projects/:project_id/versions/:version_id/downloadFormatsGET projects/:project_id/versions/:version_id/downloadFormatsYes*
GET projects/:project_id/versions/:version_id/downloadsYes*
GET projects/:project_id/versions/:version_id/itemYes*
GET projects/:project_id/versions/:version_id/refsYes*
GET projects/:project_id/versions/:version_id/relationships/linksYes*
GET projects/:project_id/versions/:version_id/relationships/refsYes*
POST projects/:project_id/versionsYes*
POST projects/:project_id/versions/:version_id/relationships/refsNo
PATCH projects/:project_id/versions/:version_idYes*
CheckPermissionYes*
ListRefsYes*
ListItemsYes*
CreateFolderYes*
PublishModelYes*
GetPublishModelJobYes*

* Note that the BIM 360 APIs do not support all the Forma Data Management features. See the Forma Data Management Compatibility documentation for details.

** Note that although these endpoints are not compatible with Forma projects, we have released a new Files API that provides the same functionality in Forma.

Hub Admin API

APIEndpointForward Compatible
AdminPOST projectsNo*
GET projectsNo*
GET projects/:project_idNo*
PATCH projects/:project_idNo*
PATCH projects/:project_id/imageYes
POST companiesYes
POST companies/importYes
GET companiesYes
GET companies/:company_idYes
GET companies/searchYes
GET projects/:project_id/companiesYes
PATCH companies/:company_idYes
PATCH companies/:company_id/imageYes
POST usersYes
POST users/importYes
GET usersYes
GET users/:user_idYes
GET users/searchYes
PATCH users/:user_idYes
GET projects/:project_id/usersYes
POST projects/:project_id/usersNo*
GET projects/:project_id/users/:user_idYes
POST projects/:project_id/users/import (v2)No*
PATCH projects/:project_id/users/user_id (v2)No*
GET projects/:project_id/industry_roles (v2)No
PUT business_units_structureYes
GET business_units_structureYes
GET jobs/:job_idNo

* Note that although these endpoints are not compatible with Forma projects, we have released new Hub Admin API endpoints that provide the same functionality, and are compatible with both BIM 360 and Forma projects.

Issues API

The BIM 360 Issues API is not compatible with Forma projects. However, we have released a new Issues API that supports Forma projects.

APIEndpointForward Compatible
IssuesGET users/meNo
GET issuesNo
GET issues/:idNo
POST issuesNo
PATCH issues/:idNo
GET issues/:id/commentsNo
POST issues/commentsNo
GET issues/attachmentsNo
POST issues/attachmentsNo
GET root-causesNo
GET ng-issue-typesNo
GET custom-attribute-definitionsNo
GET custom-attribute-mappingsNo

Locations API

APIEndpointForward Compatible
LocationsGET nodesYes

Model Coordination API

APIEndpointForward Compatible
Model CoordinationPOST modelsetsYes
GET modelsetsYes
GET jobs/:jobIdYes
GET modelsets/:modelSetIdYes
PATCH modelsets/:modelSetIdYes
POST modelsets/:modelSetId/issuesYes
POST issues/viewcontextYes
GET modelsets/:modelSetId/jobs/:jobIdYes
POST modelsets/:modelSetId/screenshotsYes
GET modelsets/:modelSetId/screenshots/:screenShotIdYes
POST modelsets/:modelSetId/versionsYes
GET modelsets/:modelSetId/versionsYes
GET modelsets/:modelSetId/versions/latestYes
GET modelsets/:modelSetId/versions/:versionYes
PATCH modelsets/:modelSetId/versions:enableYes
PATCH modelsets/:modelSetId/versions:disableYes
POST modelsets/:modelSetId/viewsYes
GET modelsets/:modelSetId/viewsYes
POST modelsets/:modelSetId/views:lineagesYes
GET modelsets/:modelSetId/views/:viewIdYes
PATCH modelsets/:modelSetId/views/:viewIdYes
DELETE modelsets/:modelSetId/views/:viewIdYes
GET modelsets/:modelSetId/versions/:version/viewsYes
GET modelsets/:modelSetId/versions/:version/views/:viewIdYes
GET modelsets/:modelSetId/views/:viewId/jobs/:jobIdYes
GET modelsets/:modelSetId/testsYes
GET modelsets/:modelSetId/versions/:version/testsYes
GET tests/:testIdYes
GET tests/:testId/resourcesYes
POST tests/:testId/clashes:closeYes
GET tests/:testId/clashes/closedYes
POST tests/:testId/clashes/closedYes
POST modelsets/:modelSetId/clashes:reopenYes
GET modelsets/:modelSetId/clashes/closedYes
POST tests/:testId/clashes:assignYes
GET tests/:testId/clashes/assignedYes
POST tests/:testId/clashes/assignedYes
GET modelsets/:modelSetId/clashes/assignedYes
GET clashes/assigned/viewcontextYes
GET clashes/jobs/:jobIdYes
POST modelsets/:modelSetId/screenshotsYes
GET modelsets/:modelSetId/screenshots/:screenShotIdYes
GET modelsets/:modelSetId/clashes/groupedYes
GET modelsets/:modelSetId/versions/:version/manifestYes
GET modelsets/:modelSetId/versions/:version/fieldsYes
POST modelsets/:modelSetId/versions/:version/indexes:queryYes
GET modelsets/:modelSetId/jobs/:jobIdYes

Relationships API

RFIs API

APIEndpointForward Compatible
RFIsGET rfisYes
GET rfis/:idYes
POST rfisYes
GET users/meYes
PATCH rfis/:idYes
GET commentsYes
POST commentsYes
GET attachmentsYes
POST attachmentsNo
DELETE attachments/:attachmentIdNo

Imported from the Autodesk Platform Services documentation: https://aps.autodesk.com/en/docs/acc/v1/overview/bim-360-compatibility/compatibility-table.