rfis
Retrieves information about all the BIM 360 RFIs (requests for information) in a project, including details about their associated comments and attachments. To get more detailed information about a single RFI see GET rfis/:id.
You can retrieve both document-related (pusphin) RFIs and project-related RFIs.
To verify whether an RFI is document-related (pusphin) or project-related, check the linkedDocument
attribute in the response. If the RFI is project-related the linkedDocument
will be assigned a null
value, if the RFI is document-related, it will be assigned an ID.
BIM 360 RFIs are managed in the BIM 360 Project Management module.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/bim360/rfis/v2/containers/:containerId/rfis |
Authentication Context | user context required |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
Request
URI Parameters
containerId string | The ID of the container. Each project is assigned a container that stores all the RFIs for the project. To find the ID, see the Retrieve a Container ID tutorial. |
Request
Query String Parameters
limit int | The number of RFIs to return in the response payload. Acceptable values: 1-200. Default value: 10. For example, to limit the response to two RFIs per page, use limit=2 |
offset int | The page number that you want to begin RFI results from. For example, to begin the results from page three, use offset=3 |
sort array: string | Sort the RFIs by createdAt , status , dueDate , title , location , updatedAt , costImpact , scheduleImpact , priority , discipline , category , reference , customIdentifier . For example, sort=status ASC . Separate multiple values with commas. To sort in descending order add a DESC after the sort criteria. For example, sort=status DESC . |
filter[status] array: string | Retrieves RFIs with the specified status. Possible values: draft , submitted , open , rejected , answered , closed & void . For example, filter[status]=open |
filter[includeHidden] boolean | Not relevant |
filter[linkedDocument] array: string | Retrieves pushpin RFIs that are associated with the specified document. Specify the document’s item ID. For example, filter[linkedDocument]=urn:adsk.wipprod:dm.lineage:tFbo9zuDTW-nPh45gnM4gA . |
filter[linkedDocumentVersion] int | Retrieves pushpin RFIs that are associated with the specified document. Specify the document’s version ID. For example, filter[linkedDocument]=urn:adsk.wipprod:fs.file:7_5NcbL1Q1GSjRLJe9ffvw&filter[linkedDocumentVersion]=1 . |
filter[assignedTo] array: string | Retrieves RFIs in the project that were assigned to the specified user. Use the user’s Autodesk ID. For example, filter[assignedTo]=PER8KQPK2JRT . To find the ID call GET users/me and check user.id . |
filter[createdAt] string | Retrieves RFIs created after the specfied date, in the following format: YYYY-MM-DDThh:mm:ss.sz, or a date range in the following format: YYYY-MM-DDThh:mm:ss.sz..YYYY-MM-DDThh:mm:ss.sz. |
filter[createdBy] array: string | Retrieves RFIs in the project that were created by the specified user. Use the user’s Autodesk ID. For example, filter[createdBy]=PER8KQPK2JRT . To find the ID call GET users/me and check user.id . |
filter[dueDate] string | Retrieves RFIs with the specified due date, in the following format: YYYY-MM-DDThh:mm:ss.sz, or a date range in the following format: YYYY-MM-DDThh:mm:ss.sz..YYYY-MM-DDThh:mm:ss.sz. |
filter[search] string | Searches for a specified string in the following fields: title , question , and officialResponse , and retrieves RFIs where the string is found. This includes RFIs where the string matches part of a field. For example, filter[search]=window . |
filter[costImpact] array: string | Retrieves RFIs with the specified cost impact value. For example, filter[costImpact]=Yes |
filter[scheduleImpact] array: string | Retrieves RFIs with the specified schedule impact value. For example, filter[scheduleImpact]=Yes |
filter[priority] array: string | Retrieves RFIs with the specified priority level. For example, filter[priority]=High |
filter[id] array: string | Retrieves a list of specified RFIs. To find the RFI IDs call GET rfis and check results.id . |
filter[discipline] array: string | Retrieves RFIs with the specified discipline type. For example, filter[discipline]=Architectural |
filter[category] array: string | Retrieves RFIs with the specified category type. For example, filter[category]=Constructability |
fields array: string | Specify which attributes you want to appear in the response. Separate multiple values with commas. For example, fields=createdBy, question . |
Response
HTTP Status Code Summary
200 OK | List of rfis |
400 Bad Request | The parameters are invalid |
401 Unauthorized | The provided bearer token is not valid |
403 Forbidden | The user or service represented by the bearer token does not have permission to perform this operation |
500 Internal Server Error | An unknown error occurred on the server |
Response
Body Structure (200)
results array: object | The list of RFIs. |
id string | The ID of the RFI. |
customIdentifier string | The identifier of the RFI given by user. |
title string | The name of the RFI. |
question string,null | The RFI question. |
virtualFolderUrn string,null | Not relevant |
status enum:string | The status of the RFI. Note that the possible statuses of the RFI depends on the workflow type assigned to the RFI.
For a default workflow with a single reviewer ( For more information about different workflows and statuses, see the RFI help documentation. To check the workflow type of an RFI, call GET users/me and check To check which statuses the user can potentially open the RFI with, call GET rfis/:id.
Possible values: |
assignedTo string | The Autodesk ID of the user.
Max length: 255 |
managerId string | The Autodesk ID of the user.
Max length: 255 |
constructionManagerId string | The Autodesk ID of the user.
Max length: 255 |
architectId string | The Autodesk ID of the user.
Max length: 255 |
reviewerId string | The Autodesk ID of the user.
Max length: 255 |
assignedToType enum:string | The type of assignee. Will always be user . |
dueDate string,null | The timestamp of the due date for the RFI, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
location object | The location object. |
description string | A description of the location of the RFI in the construction project. |
linkedDocument string | The document ID associated with the RFI. Identifies whether this RFI is a pushpin RFI or a project-related RFI. A pushpin is a visual marker that denotes the location of an RFI in a document. A project-related RFI is assigned a null value, and a pushpin RFI is assigned the item ID of the document associated with the pushpin. |
linkedDocumentVersion int | The document’s version ID associated with the RFI. Only relevant for pushpin RFIs. |
linkedDocumentCloseVersion int | The version of the document when the RFI is closed. |
attachmentsCount int | The number of attachments associated with the RFI. |
commentsCount int | The number of comments associated with the RFI. |
officialResponse string | An official response for the RFI. |
respondedAt datetime: ISO 8601 | The date and time when the RFI was responded to, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
respondedBy string | The Autodesk ID of the user who responded to the RFI. To check the name of the user, call GET projects/users. |
createdBy string | The Autodesk ID of the user who created the RFI. To check the name of the user, call GET projects/users. |
createdAt datetime: ISO 8601 | The date and time the RFI was created, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
updatedBy string | The Autodesk ID of the user who updated the RFI. To check the name of the user, call GET projects/users. |
updatedAt datetime: ISO 8601 | The date and time the RFI was updated, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
closedAt datetime: ISO 8601 | The date and time the RFI was closed, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
closedBy string | The Autodesk ID of the user who closed the RFI. To check the name of the user, call GET projects/users. |
containerId string | The ID of the container. |
projectId string | The ID of the project. |
suggestedAnswer string | The suggested answer for the RFI. |
coReviewers array: string | A list of alternative reviewers. |
distributionList array: string | The list of users who will be notified of changes to the RFI. |
answeredAt datetime: ISO 8601 | The date and time the RFI was answered, in the following format: YYYY-MM-DDThh:mm:ss.sz. |
answeredBy string | The Autodesk ID of the user who answered the RFI. To check the name of the user, call GET projects/users. |
costImpact string,null | The cost impact status of the RFI. Possible values: null , Yes , No , Unknown . |
scheduleImpact string,null | The schedule impact status of the RFI. Possible values: null , Yes , No , Unknown . |
priority string,null | The priority status of the RFI. Possible values: null , High , Normal , Low . |
discipline array: string | The disciplines of the RFI. |
category array: string | The categories of the RFI. |
reference string | An external ID; typically used when the RFI was created in another system.
Max length: 20 |
sheetMetadata object,null | Data about the document associated with the RFI. Only relevant for pushpin RFIs. |
pushpinAttributes object,null | Data about the pushpin RFI. Only relevant for pushpin RFIs. For more details, see the RFI pushpin tutorials. |
pagination object | The pagination object. |
limit int | The number of items per page. |
offset int | The page number that the results begin from. |
totalResults int | The number of items in the response. |
Example
List of rfis
Request
curl -v 'https://developer.api.autodesk.com/bim360/rfis/v2/containers/:containerId/rfis' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"results": [
{
"id": "31a3f98d-34a8-4d4c-a362-3cc9de44f89c",
"customIdentifier": "ID-1234",
"title": "RFI - pipe is not in right place",
"question": "Where should we put the pipe?",
"virtualFolderUrn": "",
"status": "open",
"assignedTo": "PER8KQPK2JRT",
"managerId": "PER8KQPK2JRT",
"constructionManagerId": "PER8KQPK2JRT",
"architectId": "PER8KQPK2JRT",
"reviewerId": "PER8KQPK2JRT",
"assignedToType": "user",
"dueDate": "2018-01-12T13:06:39.216Z",
"location": {
"description": "In the middle of the room"
},
"linkedDocument": "2018-01-12T13:06:39.216Z",
"linkedDocumentVersion": "urn:adsk.wipprod:fs.file:7_5NcbL1Q1GSjRLJe9ffvw",
"linkedDocumentCloseVersion": 1,
"attachmentsCount": 12,
"commentsCount": 15,
"officialResponse": "The measurements are correct.",
"respondedAt": "2018-01-12T13:06:39.216Z",
"respondedBy": "PER8KQPK2JRT",
"createdBy": "PER8KQPK2JRT",
"createdAt": "2018-07-22T15:05:58.033Z",
"updatedBy": "PER8KQPK2JRT",
"updatedAt": "2018-07-22T15:05:58.033Z",
"closedAt": "2018-07-22T15:05:58.033Z",
"closedBy": "PER8KQPK2JRT",
"containerId": "31a3f98d-34a8-4d4c-a362-3cc9de44f89c",
"projectId": "31a3f98d-34a8-4d4c-a362-3cc9de44f89c",
"suggestedAnswer": "The measurements are correct.",
"coReviewers": [
"PER8KQPK2JRT"
],
"distributionList": [
"PER8KQPK2JRT"
],
"answeredAt": "2018-07-22T15:05:58.033Z",
"answeredBy": "PER8KQPK2JRT",
"costImpact": "Yes",
"scheduleImpact": "Yes",
"priority": "High",
"discipline": [
"Architectural"
],
"category": [
"Constructability"
],
"reference": "ID-1234",
"sheetMetadata": "",
"pushpinAttributes": ""
}
],
"pagination": {
"limit": 10,
"offset": 0,
"totalResults": 97
}
}