Creates a catalog in user's organization context.
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 Write 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
Catalog (create/update)
Display name of the document. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.
Description of the catalog. Maximum length of the description is 250.
Region of the catalog. Maximum length of the region is 250.
Hashtags of the catalog. Maximum length of a hashtag is 50, it must not include these special characters >, <, ^, $, ?, ||.
Example
{ "displayName": "Door's Catalog", "description": "Standard wooden doors", "region": "US East", "hashtags": ["door", "woodendoor"] }
Response 201 Created
Created
{ "catalog": { "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e", "displayName": "Door's Catalog", "description": "Standard wooden doors", "region": "US East", "hashtags": ["door", "woodendoor"], "createdDateTime": "2019-11-26T17:12:40.8516569Z", "lastModifiedDateTime": "2019-11-26T17:14:12.3846681Z" } }
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 catalog.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 409 Conflict
Catalog with the same name already exists within the organization.
{ "error": { "code": "CatalogExists", "message": "Catalog with the same name already exists within the organization." } }
Response 422 Unprocessable Entity
Invalid request to upload component.
{ "error": { "code": "InvalidCreateCatalogRequest", "message": "Cannot create catalog.", "details": [{ "code": "MissingRequiredProperty", "message": "Required property is missing.", "target": "displayName" }, { "code": "InvalidValue", "message": "DisplayName is over '250' 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": "Region is over '150' length limit.", "target": "region" }, { "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.
Catalog (response)
Retrieved catalog response containing catalog.
Catalog
Id of the catalog.
Display name of the catalog.
Description of the catalog.
Region of the catalog.
Created datetime of the catalog.
Last modified datetime of the catalog.
Hashtags of the catalog.
Catalog (create/update)
Display name of the document. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.
Description of the catalog. Maximum length of the description is 250.
Region of the catalog. Maximum length of the region is 250.
Hashtags of the catalog. Maximum length of a hashtag is 50, it must not include these special characters >, <, ^, $, ?, ||.
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?