Get spare-part categories

Prev Next
Get
/v2/inventory/sparePartDefinitionCategories

Retrieves the list of spare-part definition categories.
This method returns 100 items at a time, to retrieve more items, multiple requests with incremental page number must be performed.
Required permissions: READ_SPARE_PART.

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

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

Query parameters
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 (Category)
object
name
string

The category name.

parentId
string

The id of the parent category with which the category belongs.

first
boolean

The flag indicating whether the page is the first one.

last
boolean

The flag indicating whether the last page has been reached.

totalPages
integer

The total number of pages.

totalElements
integer

The total number of elements.

sort
string

The current sorting criteria.

numberOfElements
integer

The number of elements in this page.

size
integer

The requested page size.

number
integer

The number of the page (zero-based).

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