If you worked on Autodesk Build RFI integration, you will know the history that ACC RFI v2 API was consolidated with BIM360 RFI API from year 2022. Since then, the v2 API has been deprecated. However, not all features or entity data of ACC RFI are supported with BIM360 API. Now ACC RFI v3 API has been released. The other blog describes in more details.
This blog summarizes the main points when you migrate from BIM360 RFI API to ACC RFI API.
Base URL
from
/bim360/rfis/v2/containers/:containerId
to
/construction/rfis/v3/projects/:projectId
Main Differences of API Abilities
- Added
- RFI Response (get, create, update)
- RFI Attachment (get, create, update)
- Custom Attributes definitions (get, create, update)
- Custom Attributes value(get, update)
- assignedTo supports multiple assignees (ball in court)
- watches, architects
- Removed
- Pushpin RFI (UI does not support either)
APIs Changes
This table is about the difference of those endpoints of BIM360 RFI API.
| API |
BIM 360 Endpoint |
RFI Endpoint |
Differences |
| Get permission information and roles of logged user |
GET users/me
|
GET users/me
|
- allPermittedStatuses, permittedStatuses reflects the permissions of the user in workflow US and workflow EU.
- some attributes of permittedAttributes are removed such as:
- lbsIds
- linkedDocument
- linkedDocumentVersion
- pcoLink
- the term of workflow roles are changed:
- projectCM to projectCoordinator
- projectArch to projectReviewer
|
| Get RFIs |
GET rfis
|
POST rfi-search
|
- with empty json {} in payload, to get all RFIs
- Query schemas:
- more richer searching/filter than BIM360
- Please check GET One RFI (next row) for difference of the RFI data
|
| Get One RFI |
GET rfis/:id
|
GET rfis/:id
|
- Response Added
- Architects array
- responses array
- watchers array
- locations array
- officialResponseActors array
- officialResponseEditByManagerState
- Response Removed
- linkedDocument
- linkedDocumentVersion
- sheetMetadata
- reviewerId
- architectId
- assignedToType
- lbsIds
- coReviewersRoles
- coReviewersCompanies
- distributionList
- photosPermissionsMigrated
- Response Changed
- assignedTo: from single member to an array, i.e. ball in court
- permittedStatuses are grouped by wfUS and wfEU
- reviewers[].oxygenId to reviewers[].id
- some attributes of permittedActions are changed with the updated attributes accordingly
|
| Create One RFI |
POST rfis
|
POST rfis
|
- Request Added
- id: customized UUID. Optional
- locationDescription
- watchers array
- customAttributes array
- Request Removed
- linkedDocument
- linkedDocumentVersion
- pushpinAttributes
- distributionList
- sheetMetadata
- pushpinAttributes
- Request Changed
- assignedTo: from single member to an array, i.e. ball in court
- location array to locations array
- Response difference please check GET one RFI
|
| Update One RFI |
PATCH rfis/:id
|
PATCH rfis/:id
|
- Same difference as Create RFI (POST /rfis)
- Special difference of Request
- Added: attachments array for attaching files when submitting official response
|
| Get RFI Comments |
GET comments
|
GET rfis/:rfiId/comments
|
- Response Removed
- Response added
|
| Create RFI Comments |
POST comments
|
POST rfis/:rfiId/comments
|
- Request added
- id: customized UUID for comment. Optional
|
Note: Some attributes are added, yet marked irrelevant. They are not supposed to be used in this release.
Should you have any questions, please contact at https://aps.autodesk.com/get-help.
