Get all product-models

Prev Next
Get
/v2/inventory/productModels

Retrieves the list of product-models.
This method returns 100 items at a time, to retrieve more items, multiple requests with incremental page number must be performed.
Required permissions: READ_PRODUCT_MODEL.

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

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

Query parameters
searchText
string

The search text used to filter objects (requires searchField parameter).
Use '*' for variants: starts with (foo*), contains (*foo*) or ends with (*foo).

Maximum1.0
Example*foo*
searchField
string

The name of the field in which to verify the search text.

Maximum-1.0
Examplename
size
integer

The number of elements to retrieve for the current page.

Minimum1.0
Example200
page
integer

The page number to retrieve (zero-based).

Minimum0.0
Example0
sort
string

The sorting criteria based on object properties.

Minimum0.0
Examplename,ASC
Responses
200

Successful operation.

Expand All
object
content
Array of object (ProductModel)
object
id
string
name
string
description
string
technicalDescription
string
technicalSchemes
Array of object
object
code
string
name
string
description
string
imageUrl
string
contentType
string
Valid values[ "PNG", "SVG" ]
urlType
string
Valid values[ "PNG", "SVG" ]
imageUrl
string
categoryId
string
thingDefinitionId
string
first
boolean
last
boolean
totalPages
integer
totalElements
integer
sort
string
numberOfElements
integer
size
integer
number
integer
Minimum0.0
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