Get spare-part by id

Prev Next
Get
/inventory/sparePartDefinitions/{sparePartId}

Returns the spare-part definition identified by the given id.

Required permissions: READ_SPARE_PART.

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

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

Path parameters
sparePartId
stringRequired

The spare-part identifier.

Minimum1.0
Exampleabcd1234
Responses
200

Successful operation

object
id
string

The spare-part object identifier.

name
string

The spare-part name.

code
string

The spare-part unique code.

description
string

The spare-part description text.

technicalDescription
string

The spare-part technical description text.

imageUrls
Array of string

The list of HTTPS image URL of this spare-part.

string
price
number

The spare-part price text.

categoryId
string

The id of the category this spare-part belongs.

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