Projects

Projects

Download API definition:

PATCH https://sampleHostName/projects/{id}

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.

This API is being deprecated

This API is being superseded by the iTwins API and the Access Control API. Please consider transitioning your software to the iTwins API.

With any questions, please first consult the iTwins API FAQ. If your question isn't answered there, please use our Community Support Channels to contact our developers.

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 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 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.


Request parameters

Name
In
Required?
Description
id
template
Yes

The project ID

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope projects:modify

Accept
No

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

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

Request body

project-update

Name
Type
Required?
Description
No data.

Response 200 OK

OK

json

Response 401 Unauthorized

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.

json

Response 403 Forbidden

The user has insufficient permissions for the requested operation.

json

Response 404 Not Found

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

json

Response 422 Unprocessable Entity

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

json

Response 429 Too many requests

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

json

Response headers

Name
Description
retry-after

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