Interact with your projects.

View, update, create, and delete projects.


projects

Initial technology preview release of the API.

Project API deprecation annoucement. See the (Overview Documentation)[https://developer.bentley.com/apis/projects/] for more details.

Administration

---

Add a project to my favorites list.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


add-project-to-my-favorites

OAuth access token with scope `projects:modify`

Authorization

Setting to `application/vnd.bentley.itwin-platform.v1+json` is recommended.

Accept

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

The user has insufficient permissions for the requested operation.

This response indicates that specified project was not found.

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

---

Retrieves a list of favorite projects for the logged in user. The user is determined by the authentication token.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Response

By default, each project in the returned list of projects will have only the project id, display name and project number.

A full representation of each project can be returned by specifying the *prefer* header that includes a value of *return=representation*.

---


get-my-favorite-projects

The [$top](https://www.odata.org/getting-started/basic-tutorial/#topskip) system query option requests the number of items in the queried collection to be included in the result.

$top

The [$skip](https://www.odata.org/getting-started/basic-tutorial/#topskip) query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$skip

Indicates a level of details in the response. Valid values are 'return=representation' or 'return=minimal'. The default is 'return=minimal'.

Prefer

OAuth access token with scope `projects:read`

---

Remove a project to my favorites list.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


remove-project-from-my-favorites

---

Adds a project to my recently used projects list. No more than 25 projects are stored in the recently used list. Older ones are removed to make room for new ones.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

add-project-to-my-recents

---

Retrieves a list of recently used projects for the logged in user. The user is determined by the authentication token.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Response

By default, each project in the returned list of projects will have only the project id, display name and project number.

A full representation of each project can be returned by specifying the *prefer* header that includes a value of *return=representation*.

---


get-my-recently-used-projects

---

Create new project role.

### Notes

- The POST body MUST include the displayName property.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_manage_roles` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


create-project-role

This response indicates that project or template role was not found.

Invalid request to create new project role. Make sure request had required properties and does not pass in readonly properties.

---

Delete the specified project role.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_manage_roles` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


delete-project-role

roleId

This response indicates that project or project role with specified ID was not found.

---

Retrieves a list of available user roles that are defined for a specified project.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_manage_roles` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---

get-project-roles

---

Update the specified project role.

### Notes

To assign permissions to a role PATCH body MUST include an array of permissions. If a user is not Organization Administrator permissions that could be assigned to the role
are limited to permissions the user has on a project.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_manage_roles` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---

update-project-role

A project role instance with the fields that should be updated.

This response indicates that project or role with specified ID was not found.

Invalid request to create new project role. Request payload might be missing some of the required properties.

---

Add new project team member

### Notes

The POST body MUST include either a *userId* property or an *e-mail* property.

When adding members by ids, the POST body MAY include the roleIds property, which MUST be defined as an array of role IDs that will be assigned to new team member.

When adding members by names, the POST body MAY include the roleNames property, which MUST be defined as an array of role names that will be assigned to new team member.

When adding members *Team Member* role will be assigned to all members. *Team Member* role grants member write access to Storage and Forms APIs. *Team Member* can be removed from any member if access to Storage and Forms APIs is not desired. 

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_invite_member` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


add-project-team-member

Project team member was successfully added.

Location

This response indicates that project or some of the roles with specified ID were not found.

Invalid request to add new project team member. Team member already exists in project.

Invalid request to add new project team member. Request payload might be missing some of the required properties.

---

Retrieves a list of permissions the user has for a specified project.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-user-permissions

This response indicates that project with specified ID was not found.

---

Retrieves detailed information of specific team member for a specified project.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given project or be a project team member.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---

get-project-team-member-details

memberId

This response indicates that project or team member with specified ID was not found.

---

Retrieves a list of team members and their roles assigned to a specified project.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given project or be a project team member.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Response

By default, each member in the returned list of members will only have names of the roles that are assigned to the user.

A full representation of roles assigned to the member can be returned by specifying the *prefer* header that includes a value of *return=representation*.


---

get-project-team-members

The [$top](https://www.odata.org/getting-started/basic-tutorial/#topskip) system query option requests the number of items in the queried collection to be included in the result. Value must be less or equal to 100.

Invalid request to get project team members.

---

Remove the specified project team member.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_remove_member` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


remove-project-team-member

Specified project team member was successfully removed.

---

Update project team member roles

### Notes

The PATCH body MUST include the roleIds property, which MUST be defined as an array of role IDs that will be assigned to new team member.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_invite_member` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


update-project-team-member-roles

This response indicates that project, team member or some of the roles with specified IDs were not found.

Invalid request to update team member roles. Request payload might be missing some of the required properties.

---

Create a new project

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization
If a user is affiliated with an Organization, then the user must be an Organization Administrator in order to create a project.  The new project will be owned by the Organization.   
Example: john.doe@starkindustries.com is an Organization Administrator that works for Stark Industries that has an account with Bentley. John will be able to create projects and those projects will belong to Stark Industries. John and any other Organization Administrator for Stark Industries will be able to update or delete the project.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

Any user that is not affiliated with an Organization can create a project. The new project will be owned by the user account.   
Example: jane.doe@gmail.com is an independent contractor that does not have an account with Bentley. Jane will be able to create projects and those projects will belong to Jane. Only Jane will be able to update or delete the project.

---


create-project

Invalid request to create a project.  Review the 'Field Values' section near the top of this page.

---

Delete the specified project.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization
If a user is affiliated with an Organization, then the user must be an Organization Administrator in order to delete a project that is owned by the Organization.  
Example: john.doe@starkindustries.com is an Organization Administrator that works for Stark Industries that has an account with Bentley. John will be able to delete any project that belongs to Stark Industries. 

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

A user that is not affiliated with an Organization can delete projects that are owned by the user account.  
Example: jane.doe@gmail.com is an independent contractor that does not have an account with Bentley. Jane will be able to delete any project that belongs to Jane. Jane owns any project that she created.

---


delete-project

---

Retrieves a list of projects that can be accessed by the logged in user. The user is determined by the authentication token. See the Authorization section for information on how access rights are determined.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given project or be a project team member.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Response

By default, each project in the returned list of projects will have only the project id, display name and project number.

A full representation of each project can be returned by specifying the *prefer* header that includes a value of *return=representation*.

---


my-projects

Find all projects with the exact projectNumber specified. Cannot be used at the same time as the $search parameter.

projectNumber

Find all projects with the exact displayName specified. Cannot be used at the same time as the $search parameter.

displayName

Find all projects that have the search string anywhere in the projectNumber or displayName. Cannot be used at the same time as the projectNumber or displayName parameters.

$search

---

Gets the details of the specified project.  

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns the specified project or be a project team member.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---


get-project

This response indicates that the specified project was not found.

---

Update the specified project.

For updates, all properties are optional. The request payload only needs to contain the properties that you would like to update. 

### Authentication

Requires `Authorization` header with valid Bearer token for scope `projects:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization
If a user is affiliated with an Organization, then the user must be an Organization Administrator in order to update a project that is owned by the Organization.  
Example: john.doe@starkindustries.com is an Organization Administrator that works for Stark Industries that has an account with Bentley. John will be able to update any project that belongs to Stark Industries. 

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

A user that is not affiliated with an Organization can update projects that are owned by the user account.  
Example: jane.doe@gmail.com is an independent contractor that does not have an account with Bentley. Jane will be able to update any project that belong to Jane. Jane owns any project that she created.

---


update-project

A project instance with the fields that should be updated.  ReadOnly fields should not be included.  

This response indicates that one of the associated entities could not be found.

Invalid request to update a project.  Review the 'Field Values' section near the top of this page.

Changelog

Aug 5, 2022

Projects

Changelog

Aug 5, 2022