Projects

Projects

Download API definition:

POST https://sampleHostName/projects/

Create a new project

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


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.

Request body

project-create

Name
Type
Required?
Description
No data.

Response 201 Created

Project successfully created.

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

json

Response 409 Conflict

Conflict

json

Response 422 Unprocessable Entity

Invalid request to create 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.