Get product-model by id

Prev Next
Get
/inventory/productModels/{productModelId}

Required permissions: READ_PRODUCT_MODEL.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Path parameters
productModelId
stringRequired

The product-model identifier.

Minimum1.0
Exampleabcd1234
Responses
200

Successful operation

Expand All
object
id
string

The product-model object identifier.

name
string

The product-model name.

description
string

The product-model description text.

technicalDescription
string

The product-model technical description text.

technicalSchemes
Array of object

The technical schems associated with this product-model.

object
code
string

The schema identification code.

name
string

The schema name.

description
string

The schema description text.

imageUrl
string

The schema HTTPS image URL.

contentType
string

The schema image content type. In case of SVG, the schema is embedded into the page HTML and became clickable according to positions.

Valid values[ "PNG", "SVG" ]
urlType
string Deprecated

Use contentType instead.

Valid values[ "PNG", "SVG" ]
imageUrl
string

The product-model HTTPS image URL.

categoryId
string

The id of the category this product-model belongs.

thingDefinitionId
string

The id of the thing-definition with which the product-model is associated.

401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error