Create Manufacturer - Library

REST API Overview

Reference

Changelog

Library

Download API definition:

Create Manufacturer

POST https://qa-api.bentley.com/library/manufacturers

Creates a manufacturer 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

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Manufacturer (create/update)

displayName

String

Yes

Display name of the manufacturer. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.

phone

String

Phone of the manufacturer.Maximum length of the phone is 250.

address

String

Address of the manufacturer. Maximum length of the address is 250.

website

String

Website of the manufacturer. Maximum length of the website is 250.

Example

json

{
    "displayName": "ABC",
    "phone": "+1 800-910-9999",
    "address": "999 Main St, ABC NY 12345",
    "website": "www.abc123.com"
}

Response

Response 201 Created

Created

json

{
    "manufacturer": {
        "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
        "displayName": "ABC",
        "phone": "+1 800-910-9999",
        "address": "999 Main St, ABC NY 12345",
        "website": "www.abc123.com",
        "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.

json

{
    "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 manufacturer.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 409 Conflict

Manufacturer with the same name already exists within the organization.

json

{
    "error": {
        "code": "ManufacturerExists",
        "message": "Manufacturer with the same name already exists within the organization."
    }
}

Response 422 Unprocessable Entity

Invalid request to upload component.

json

{
    "error": {
        "code": "InvalidCreateManufacturerRequest",
        "message": "Cannot create manufacturer.",
        "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": "Phone is over '250' length limit.",
                "target": "phone"
            },
            {
                "code": "InvalidValue",
                "message": "Address is over '250' length limit.",
                "target": "address"
            },
            {
                "code": "InvalidValue",
                "message": "Website is over '250' length limit.",
                "target": "website"
            }
        ]
    }
}

Response 429 Too many requests

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

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

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

Definitions

Manufacturer (response)

Retrieved manufacturer response containing manufacturer.

manufacturer

Manufacturer

Full representation of the manufacturer.

Manufacturer

String

Id of the manufacturer.

displayName

String

Display name of the manufacturer.

phone

String

Phone of the manufacturer.

address

String

Address of the manufacturer.

website

String

Website of the manufacturer.

createdDateTime

String

Created datetime of the manufacturer.

lastModifiedDateTime

String

Last modified datetime of the manufacturer.

Manufacturer (create/update)

displayName

String

Display name of the manufacturer. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.

phone

String

Phone of the manufacturer.Maximum length of the phone is 250.

address

String

Address of the manufacturer. Maximum length of the address is 250.

website

String

Website of the manufacturer. Maximum length of the website is 250.

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

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.

error

Error

Error information.