Documentation Index

Fetch the complete documentation index at: https://learn.servitly.com/llms.txt

Use this file to discover all available pages before exploring further.

Create new spare-part-reference

Prev Next
Post
/inventory/productModelSparePartDefinitionReferences

Creates a new spare-part-reference, i.e. the link between a spare-part definition and a product-model or one of its parts.
The reference declares how many occurrences of the spare-part are used (quantity), the optional group it belongs to and its technicalSchemePosition, and it is what makes the spare-part visible and orderable for that product.

Required permissions: READ_PRODUCT_MODEL, READ_SPARE_PART, WRITE_SPARE_PART.

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

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

Body parameters

The details of the spare-part-reference being created.

object
sparePartDefinitionId
string Required

The id of the referenced spare-part definition.

productModelId
string Required

The id of the product-model from which the spare-part is referenced.

productModelPartId
string

The optional id of the product-model-part from which the spare-part is referenced.

group
string

The optional group associated with the reference.

quantity
integer

The occurrences of the spare-part in this reference (default 1).

technicalSchemePosition
string

The position identifier within the scheme of the parent element (product model or model part).

Responses
201

Successful creation.

object
id
string

The spare-part object identifier.

sparePartDefinitionId
string

The id of the referenced spare-part definition.

productModelId
string

The id of the product-model from which the spare-part is referenced.

productModelPartId
string

The optional id of the product-model-part from which the spare-part is referenced.

group
string

The optional group associated with the reference.

quantity
integer

The occurrences of the spare-part in this reference (default 1).

technicalSchemePosition
string

The position identifier within the scheme of the parent element (product model or model part).

400

Request data not valid.

object
message
string

The error response.

ExampleBad request
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
429

API call rate limit exceeded.

object
message
string

The error response.

ExampleAPI call rate limit exceeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error