users/me
This endpoint is deprecated. We will continue supporting it until September 1, 2022. We recommend migrating to the BIM 360 API endpoints, which are compatible with ACC projects.
Retrieves information about an end user, including the type of workflow roles assigned to the user, whether the user is permitted to create RFIs, which states the user can create the RFIs in, and the attributes that are required when creating the RFIs in the different states.
We strongly recommend calling this endpoint before creating RFIs, in order to verify the most up-to-date permissions and actions.
Users who have been assigned either creator (projectSC
) or manager (projectGC
) workflow roles can create RFIs. All users in the project are automatically assigned the creator workflow role. To assign creator or manager workflow roles to project members, click Settings on the top right, and select Permissions. A list of users is displayed. Select the appropriate role from the Workflow role dropdown on the right. Note that in order to allocate workflow roles, you must have User Admin status.
Note that only users who are members of a project can potentially create and edit RFIs for the project. To check which users are members of a project, call GET users (BIM 360 or ACC). If a user is not a project member, the endpoint will return an error. Note that although we support grouping users by project for BIM 360 projects, we currently only support grouping users by account for ACC projects.
If the createRfi
object appears in the response in the permittedActions
object, it indicates that the user can create RFIs.
Currently, you can only assign workflow roles (creator, manager, reviewer) in the UI.
The following table displays RFIs UI workflow role names and the corresponding RFIs API workflow role names:
RFIs UI Workflow Role Name | RFIs API Workflow Role Name |
---|---|
Creator | Subcontractor (projectSC) |
Manager | General Contractor (projectGC) |
Reviewer 1 (EMEA workflow) | Construction Manager (projectCM) |
Reviewer (US workflow) / Reviewer 2 (EMEA workflow) | Architect (projectArch) |
For information about RFI workflow role permissions, see the RFIs help documentation (BIM 360 or ACC).
Currently, you can only select an RFI workflow type for an RFI in the UI. To assign an RFI workflow to an RFI, see the RFIs help documentation (BIM 360 or ACC)
The following table displays RFIs UI workflow type names and the corresponding RFIs API workflow type names:
RFIs UI Workflow Type Name | RFIs API Workflow Type Name |
---|---|
Default Workflow | US |
Workflow with Additional Reviewer | EMEA |
Note that you can use either type of workflow in the US and in EMEA.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/rfis/v2/projects/:projectId/users/me |
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. |
x-ads-region string | The region to which your request should be routed. If not set, the request is routed automatically but may incur a small latency increase. Possible values: US , EMEA . |
Request
URI Parameters
projectId string | The ID of the project. |
Response
HTTP Status Code Summary
200 OK | Success |
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)
user object | User data object |
id string | The Autodesk ID of the user. |
name string | The name of the user |
role enum:string | The type of user.
Possible values: project_user , project_admin |
permittedActions object | The list of actions that are permitted for the user. |
createRfi object | The list of attributes available for the user.
Note that the appearance of this attribute in the response indicates that the user can create RFIs. |
permittedStatuses array: object | The list of statuses the user is permitted to transition an RFI to. |
status enum:string | The status of the RFI. Note that the possible statuses of the RFI depend 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 RFIs help documentation (BIM 360 or ACC). To check the workflow type of an RFI, call GET users/me (BIM 360 or ACC) and check To check which statuses the user can potentially open the RFI with, call GET rfis/:id (BIM 360 or ACC).
Possible values: |
requiredAttributes array: object | The list of attributes that are required when creating an RFI. |
name string | The name of the RFI attribute. |
values array: object | The list of possible values for the attribute. |
value string | The value of the RFI attribute. |
type string | The type of RFI attribute. |
workflow object | The RFIs workflow data object for the user |
roles array: string | A list of workflow roles assigned to the user.
For information about workflow roles, see the RFIs help documentation (BIM 360 or ACC). |
type enum:string | The type of RFI workflow for the project. Possible values: US , EU .
Note that currently you cannot use the RFIs API to select an RFI workflow. For information about selecting an RFI workflow for a project, see the RFIs help documentation (BIM 360 or ACC). |
Example
Success
Request
curl -v 'https://developer.api.autodesk.com/construction/rfis/v2/projects/21a3f98d-34a8-4d4c-a362-3cc9de44f8aa/users/me' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"user": {
"id": "BZPWJWWWMLSV",
"name": "Jon Doe",
"role": "project_admin"
},
"permittedActions": {
"createRfi": {
"permittedStatuses": [
{
"status": "open",
"requiredAttributes": [
{
"name": "assignedTo",
"values": [
{
"value": "PER8KQPK2JRT",
"type": "user"
}
]
}
]
}
]
}
},
"workflow": {
"roles": [
"projectSC"
],
"type": "US"
}
}