Creates component in user's organization context.
Notes
To create a component, displayName and status are required properties.
Component status values are: -Draft -Published -Checked -Approved -Archived By default a component is created with Draft state, subsequently it can be updated to other states during component's validation cycle. Only published components can be used in project scope.
Associated Entities
A component can have associated entities, e.g catalogs, application, category, manufacturer. These values should be valid Ids of existing entities.
Authentication
Requires Authorization header with valid Bearer token for scope itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Authorization
User must be an Organization Administrator for the Organization or have Upload permission assigned at the organization 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 wiki page.
Rate limits
All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
Component (create/update)
Display name of the component. Maximum length of the display name is 150, it must not include these special characters >, <, ^, $, ?, ||.
Description of the component. Maximum length of the description is 250.
List of associated catalog Ids, must be string values of valid GUIDs of existing catalogs.
Associated application Id, must be a string value of valid GUID of existing application.
Associated category Id, must be a string value of valid GUID of existing category.
Associated manufacturer Id, must be a string value of valid GUID of existing manufacturer.
Hashtags of the component. Maximum length of a hashtag is 50, it must not include these special characters >, <, ^, $, ?, ||.
Example
{ "displayName": "Door", "description": "A standard wooden door", "state": "Draft", "catalogs": [], "category": "c7391e2d-e3e2-4c38-b5d9-0573a01e590d", "application": "ht391e2d-e3e2-4c38-b5d9-0573a01e597j", "manufacturer": "e944f052-c026-40d6-b412-8c3c12004cac", "hashtags": [ "door", "woodendoor" ] }
Response 201 Created
Created
{ "component": { "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e", "displayName": "Door", "description": "A standard wooden door", "hashtags": [ "door", "woodendoor" ], "state": "Published", "supportedFileTypes": [ "RFA" ], "createdDateTime": "2019-11-26T17:12:40.8516569Z", "lastModifiedDateTime": "2019-11-26T17:14:12.3846681Z", "_links": { "catalogs": [{ "href": "https://api.bentley.com/library/catalogs/c7391e2d-e3e2-4c38-b5d9-0573a01e590d" }, { "href": "https://api.bentley.com/library/catalogs/ht391e2d-e3e2-4c38-b5d9-0573a01e597j" } ], "application": { "href": "https://api.bentley.com/library/applications/jy491e2d-e3e2-4c38-b5d9-0573a01e586h" }, "category": { "href": "https://api.bentley.com/library/categories/r444f052-c026-40d6-b412-8c3c12004ebe" }, "manufacturer": { "href": "https://api.bentley.com/library/manufacturers/e944f052-c026-40d6-b412-8c3c12004cac" } } } }
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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 403 Forbidden
This response indicates that user does not have required permissions to create component.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 422 Unprocessable Entity
Invalid request to upload component.
{ "error": { "code": "InvalidCreateComponentRequest", "message": "Cannot create component.", "details": [{ "code": "MissingRequiredProperty", "message": "Required property is missing.", "target": "displayName" }, { "code": "MissingRequiredProperty", "message": "Required property is missing.", "target": "state" }, { "code": "InvalidValue", "message": "State must be one of: Draft, Published, Checked, Approved, Archived.", "target": "state" }, { "code": "InvalidValue", "message": "Provided Referenced entities not valid." }, { "code": "InvalidValue", "message": "DisplayName is over '150' length limit.", "target": "displayName" }, { "code": "InvalidValue", "message": "DisplayName must not include these special characters. >, <, ^, $, ?, ||.", "target": "displayName" }, { "code": "InvalidValue", "message": "Description is over '250' length limit.", "target": "description" }, { "code": "InvalidValue", "message": "Category must be string value of a valid GUID.", "target": "category" }, { "code": "InvalidValue", "message": "Application must be string value of a valid GUID.", "target": "application" }, { "code": "InvalidValue", "message": "Manufacturer must be string value of a valid GUID.", "target": "manufacturer" }, { "code": "InvalidValue", "message": "Catalog 'catalogname' must be string value of a valid GUID.", "target": "catalogs" }, { "code": "InvalidValue", "message": "Hashtag is over '50' length limit.", "target": "hashtag" }, { "code": "InvalidValue", "message": "Hashtag must not include these special characters. >, <, ^, $, ?, ||.", "target": "hashtag" } ] } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
Component (response)
Retrieved component response containing component.
Component state
Indicates the state of component.
Component
Id of the component.
Display name of the component.
Description of the component.
Created datetime of the component.
Last modified datetime of the component.
Supported file types of the component.
Hashtags of the component.
Component (create/update) state
Indicates the state of component.
Component (create/update)
Display name of the component. Maximum length of the display name is 150, it must not include these special characters >, <, ^, $, ?, ||.
Description of the component. Maximum length of the description is 250.
List of associated catalog Ids, must be string values of valid GUIDs of existing catalogs.
Associated application Id, must be a string value of valid GUID of existing application.
Associated category Id, must be a string value of valid GUID of existing category.
Associated manufacturer Id, must be a string value of valid GUID of existing manufacturer.
Hashtags of the component. Maximum length of a hashtag is 50, it must not include these special characters >, <, ^, $, ?, ||.
Component Links
Hyperlinks to related data which complements this entity.
Link
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
Was this page helpful?