The Parts and Part Categories section of the InvenTree API schema is documented below.
InvenTree API 196¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
part¶
GET /api/part/¶
Description
Generic handler for a download request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
active |
query | boolean | No | ||
ancestor |
query | integer | No | ||
assembly |
query | boolean | No | ||
component |
query | boolean | No | ||
convert_from |
query | integer | No | ||
created_after |
query | string | No | Updated after | |
created_before |
query | string | No | Updated before | |
default_location |
query | integer | No | Default Location | |
depleted_stock |
query | boolean | No | Depleted Stock | |
exclude_tree |
query | integer | No | ||
has_ipn |
query | boolean | No | Has IPN | |
has_pricing |
query | boolean | No | Has Pricing | |
has_stock |
query | boolean | No | Has stock | |
has_units |
query | boolean | No | Has units | |
in_bom_for |
query | integer | No | ||
IPN |
query | string | No | Filter by exact IPN (internal part number) | |
IPN_regex |
query | string | No | Filter by regex on IPN (internal part number) | |
is_template |
query | boolean | No | ||
limit |
query | integer | No | Number of results to return per page. | |
low_stock |
query | boolean | No | Low stock | |
name_regex |
query | string | No | Filter by name (regex) | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
purchaseable |
query | boolean | No | ||
salable |
query | boolean | No | ||
search |
query | string | No | A search term. | |
stock_to_build |
query | boolean | No | Required for Build Order | |
stocktake |
query | boolean | No | Has stocktake | |
tags_name |
query | string | No | ||
tags_slug |
query | string | No | ||
trackable |
query | boolean | No | ||
unallocated_stock |
query | boolean | No | Unallocated stock | |
variant_of |
query | integer | No | Variant Of | |
virtual |
query | boolean | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Part"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/¶
Description
API endpoint for accessing a list of Part objects, or creating a new Part instance.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"barcode_hash",
"building",
"category",
"category_default_location",
"creation_date",
"external_stock",
"full_name",
"in_stock",
"minimum_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"barcode_hash",
"building",
"category",
"category_default_location",
"creation_date",
"external_stock",
"full_name",
"in_stock",
"minimum_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"barcode_hash",
"building",
"category",
"category_default_location",
"creation_date",
"external_stock",
"full_name",
"in_stock",
"minimum_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
Response 201 Created
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the response body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"barcode_hash",
"building",
"category",
"category_default_location",
"creation_date",
"external_stock",
"full_name",
"in_stock",
"minimum_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
DELETE /api/part/attachment/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/part/attachment/¶
Description
API endpoint for listing, creating and bulk deleting a PartAttachment (file upload).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | ||
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PartAttachment"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/attachment/¶
Description
API endpoint for listing, creating and bulk deleting a PartAttachment (file upload).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"part",
"pk",
"upload_date",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"part",
"pk",
"upload_date",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"part",
"pk",
"upload_date",
"user_detail"
],
"type": "object"
}
Response 201 Created
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"part",
"pk",
"upload_date",
"user_detail"
],
"type": "object"
}
DELETE /api/part/attachment/{id}/¶
Description
Detail endpoint for PartAttachment model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/attachment/{id}/¶
Description
Detail endpoint for PartAttachment model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"part",
"pk",
"upload_date",
"user_detail"
],
"type": "object"
}
PATCH /api/part/attachment/{id}/¶
Description
Detail endpoint for PartAttachment model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"part",
"pk",
"upload_date",
"user_detail"
],
"type": "object"
}
PUT /api/part/attachment/{id}/¶
Description
Detail endpoint for PartAttachment model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"part",
"pk",
"upload_date",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"part",
"pk",
"upload_date",
"user_detail"
],
"type": "object"
}
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"part",
"pk",
"upload_date",
"user_detail"
],
"type": "object"
}
Response 200 OK
{
"attachment": "string",
"comment": "string",
"filename": "string",
"link": "string",
"part": 0,
"pk": 0,
"upload_date": "2022-04-13",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartAttachment class.",
"properties": {
"attachment": {
"format": "uri",
"type": "string"
},
"comment": {
"description": "File comment",
"maxLength": 100,
"type": "string"
},
"filename": {
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"upload_date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User",
"nullable": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"part",
"pk",
"upload_date",
"user_detail"
],
"type": "object"
}
GET /api/part/category/¶
Description
Generic handler for a download request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cascade |
query | boolean | No | Include sub-categories in filtered results | |
depth |
query | number | No | Filter by category depth | |
exclude_tree |
query | integer | No | ||
limit |
query | integer | No | Number of results to return per page. | |
name |
query | string | No | ||
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
parent |
query | integer | No | Filter by parent category | |
search |
query | string | No | A search term. | |
starred |
query | boolean | No | Filter by starred categories | |
structural |
query | boolean | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Category"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/category/¶
Description
API endpoint for accessing a list of PartCategory objects.
- GET: Return a list of PartCategory objects
- POST: Create a new PartCategory object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pk",
"starred",
"subcategories",
"url"
],
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pk",
"starred",
"subcategories",
"url"
],
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pk",
"starred",
"subcategories",
"url"
],
"type": "object"
}
Response 201 Created
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the response body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pk",
"starred",
"subcategories",
"url"
],
"type": "object"
}
GET /api/part/category/parameters/¶
Description
API endpoint for accessing a list of PartCategoryParameterTemplate objects.
- GET: Return a list of PartCategoryParameterTemplate objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/CategoryParameterTemplate"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/category/parameters/¶
Description
API endpoint for accessing a list of PartCategoryParameterTemplate objects.
- GET: Return a list of PartCategoryParameterTemplate objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"category",
"category_detail",
"parameter_template",
"parameter_template_detail",
"pk"
],
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"category",
"category_detail",
"parameter_template",
"parameter_template_detail",
"pk"
],
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"category",
"category_detail",
"parameter_template",
"parameter_template_detail",
"pk"
],
"type": "object"
}
Response 201 Created
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"category",
"category_detail",
"parameter_template",
"parameter_template_detail",
"pk"
],
"type": "object"
}
DELETE /api/part/category/parameters/{id}/¶
Description
Detail endpoint for the PartCategoryParameterTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/category/parameters/{id}/¶
Description
Detail endpoint for the PartCategoryParameterTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"category",
"category_detail",
"parameter_template",
"parameter_template_detail",
"pk"
],
"type": "object"
}
PATCH /api/part/category/parameters/{id}/¶
Description
Detail endpoint for the PartCategoryParameterTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
Response 200 OK
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"category",
"category_detail",
"parameter_template",
"parameter_template_detail",
"pk"
],
"type": "object"
}
PUT /api/part/category/parameters/{id}/¶
Description
Detail endpoint for the PartCategoryParameterTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"category",
"category_detail",
"parameter_template",
"parameter_template_detail",
"pk"
],
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"category",
"category_detail",
"parameter_template",
"parameter_template_detail",
"pk"
],
"type": "object"
}
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"category",
"category_detail",
"parameter_template",
"parameter_template_detail",
"pk"
],
"type": "object"
}
Response 200 OK
{
"category": 0,
"category_detail": null,
"default_value": "string",
"parameter_template": 0,
"parameter_template_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for the PartCategoryParameterTemplate model.",
"properties": {
"category": {
"description": "Part Category",
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"readOnly": true
},
"default_value": {
"description": "Default Parameter Value",
"maxLength": 500,
"type": "string"
},
"parameter_template": {
"description": "Parameter Template",
"type": "integer"
},
"parameter_template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"category",
"category_detail",
"parameter_template",
"parameter_template_detail",
"pk"
],
"type": "object"
}
GET /api/part/category/parameters/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/part/category/parameters/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/part/category/parameters/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/part/category/tree/¶
Description
API endpoint for accessing a list of PartCategory objects ready for rendering a tree.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"icon": "string",
"name": "string",
"parent": 0,
"pk": 0,
"structural": true,
"subcategories": 0
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/CategoryTree"
},
"type": "array"
}
},
"type": "object"
}
DELETE /api/part/category/{id}/¶
Description
Custom delete method to pass kwargs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/category/{id}/¶
Description
Custom get method to pass kwargs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the response body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pk",
"starred",
"subcategories",
"url"
],
"type": "object"
}
PATCH /api/part/category/{id}/¶
Description
Custom patch method to pass kwargs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the response body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pk",
"starred",
"subcategories",
"url"
],
"type": "object"
}
PUT /api/part/category/{id}/¶
Description
Custom put method to pass kwargs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pk",
"starred",
"subcategories",
"url"
],
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pk",
"starred",
"subcategories",
"url"
],
"type": "object"
}
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the request body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pk",
"starred",
"subcategories",
"url"
],
"type": "object"
}
Response 200 OK
{
"default_keywords": "string",
"default_location": 0,
"description": "string",
"icon": "string",
"level": 0,
"name": "string",
"parent": 0,
"parent_default_location": 0,
"part_count": 0,
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0,
"url": "string"
}
Schema of the response body
{
"description": "Serializer for PartCategory.",
"properties": {
"default_keywords": {
"description": "Default keywords for parts in this category",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"default_location": {
"description": "Default location for parts in this category",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Description (optional)",
"maxLength": 250,
"type": "string"
},
"icon": {
"description": "Icon (optional)",
"maxLength": 100,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"nullable": true,
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"pathstring": {
"description": "Path",
"maxLength": 250,
"title": "Path",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"starred": {
"description": "Return True if the category is directly \"starred\" by the current user.",
"readOnly": true,
"type": "boolean"
},
"structural": {
"description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
"type": "boolean"
},
"subcategories": {
"readOnly": true,
"type": "integer"
},
"url": {
"readOnly": true,
"type": "string"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pk",
"starred",
"subcategories",
"url"
],
"type": "object"
}
GET /api/part/category/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/part/category/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/part/category/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
POST /api/part/change_category/¶
Description
API endpoint to change the location of multiple parts in bulk.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"category": 0,
"parts": [
0
]
}
Schema of the request body
{
"description": "Serializer for changing PartCategory for multiple Part objects.",
"properties": {
"category": {
"description": "Select category",
"type": "integer"
},
"parts": {
"items": {
"title": "Parts",
"type": "integer"
},
"type": "array"
}
},
"required": [
"category",
"parts"
],
"type": "object"
}
{
"category": 0,
"parts": [
0
]
}
Schema of the request body
{
"description": "Serializer for changing PartCategory for multiple Part objects.",
"properties": {
"category": {
"description": "Select category",
"type": "integer"
},
"parts": {
"items": {
"title": "Parts",
"type": "integer"
},
"type": "array"
}
},
"required": [
"category",
"parts"
],
"type": "object"
}
{
"category": 0,
"parts": [
0
]
}
Schema of the request body
{
"description": "Serializer for changing PartCategory for multiple Part objects.",
"properties": {
"category": {
"description": "Select category",
"type": "integer"
},
"parts": {
"items": {
"title": "Parts",
"type": "integer"
},
"type": "array"
}
},
"required": [
"category",
"parts"
],
"type": "object"
}
Response 201 Created
{
"category": 0,
"parts": [
0
]
}
Schema of the response body
{
"description": "Serializer for changing PartCategory for multiple Part objects.",
"properties": {
"category": {
"description": "Select category",
"type": "integer"
},
"parts": {
"items": {
"title": "Parts",
"type": "integer"
},
"type": "array"
}
},
"required": [
"category",
"parts"
],
"type": "object"
}
GET /api/part/internal-price/¶
Description
API endpoint for list view of PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | ||
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PartInternalPrice"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/internal-price/¶
Description
API endpoint for list view of PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
Response 201 Created
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
DELETE /api/part/internal-price/{id}/¶
Description
Detail endpoint for PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/internal-price/{id}/¶
Description
Detail endpoint for PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
PATCH /api/part/internal-price/{id}/¶
Description
Detail endpoint for PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
Response 200 OK
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
PUT /api/part/internal-price/{id}/¶
Description
Detail endpoint for PartInternalPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
Response 200 OK
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for internal prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
GET /api/part/parameter/¶
Description
API endpoint for accessing a list of PartParameter objects.
- GET: Return list of PartParameter objects
- POST: Create a new PartParameter object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | ||
search |
query | string | No | A search term. | |
template |
query | integer | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/parameter/¶
Description
API endpoint for accessing a list of PartParameter objects.
- GET: Return list of PartParameter objects
- POST: Create a new PartParameter object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template",
"template_detail"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template",
"template_detail"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template",
"template_detail"
],
"type": "object"
}
Response 201 Created
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the response body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template",
"template_detail"
],
"type": "object"
}
GET /api/part/parameter/template/¶
Description
API endpoint for accessing a list of PartParameterTemplate objects.
- GET: Return list of PartParameterTemplate objects
- POST: Create a new PartParameterTemplate object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
category |
query | integer | No | ||
checkbox |
query | boolean | No | ||
has_choices |
query | boolean | No | Has Choice | |
has_units |
query | boolean | No | Has Units | |
limit |
query | integer | No | Number of results to return per page. | |
name |
query | string | No | ||
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | ||
search |
query | string | No | A search term. | |
units |
query | string | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PartParameterTemplate"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/parameter/template/¶
Description
API endpoint for accessing a list of PartParameterTemplate objects.
- GET: Return list of PartParameterTemplate objects
- POST: Create a new PartParameterTemplate object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the request body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"parts",
"pk"
],
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the request body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"parts",
"pk"
],
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the request body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"parts",
"pk"
],
"type": "object"
}
Response 201 Created
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the response body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"parts",
"pk"
],
"type": "object"
}
DELETE /api/part/parameter/template/{id}/¶
Description
API endpoint for accessing the detail view for a PartParameterTemplate object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/parameter/template/{id}/¶
Description
API endpoint for accessing the detail view for a PartParameterTemplate object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the response body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"parts",
"pk"
],
"type": "object"
}
PATCH /api/part/parameter/template/{id}/¶
Description
API endpoint for accessing the detail view for a PartParameterTemplate object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the request body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the request body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the request body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the response body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"parts",
"pk"
],
"type": "object"
}
PUT /api/part/parameter/template/{id}/¶
Description
API endpoint for accessing the detail view for a PartParameterTemplate object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the request body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"parts",
"pk"
],
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the request body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"parts",
"pk"
],
"type": "object"
}
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the request body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"parts",
"pk"
],
"type": "object"
}
Response 200 OK
{
"checkbox": true,
"choices": "string",
"description": "string",
"name": "string",
"parts": 0,
"pk": 0,
"units": "string"
}
Schema of the response body
{
"description": "JSON serializer for the PartParameterTemplate model.",
"properties": {
"checkbox": {
"description": "Is this parameter a checkbox?",
"type": "boolean"
},
"choices": {
"description": "Valid choices for this parameter (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"description": {
"description": "Parameter description",
"maxLength": 250,
"type": "string"
},
"name": {
"description": "Parameter Name",
"maxLength": 100,
"type": "string"
},
"parts": {
"description": "Number of parts using this template",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"units": {
"description": "Physical units for this parameter",
"maxLength": 25,
"type": "string"
}
},
"required": [
"name",
"parts",
"pk"
],
"type": "object"
}
GET /api/part/parameter/template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/part/parameter/template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/part/parameter/template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
DELETE /api/part/parameter/{id}/¶
Description
API endpoint for detail view of a single PartParameter object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/parameter/{id}/¶
Description
API endpoint for detail view of a single PartParameter object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the response body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template",
"template_detail"
],
"type": "object"
}
PATCH /api/part/parameter/{id}/¶
Description
API endpoint for detail view of a single PartParameter object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the response body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template",
"template_detail"
],
"type": "object"
}
PUT /api/part/parameter/{id}/¶
Description
API endpoint for detail view of a single PartParameter object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template",
"template_detail"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template",
"template_detail"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the request body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template",
"template_detail"
],
"type": "object"
}
Response 200 OK
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"pk": 0,
"template": 0,
"template_detail": null
}
Schema of the response body
{
"description": "JSON serializers for the PartParameter model.",
"properties": {
"data": {
"description": "Parameter Value",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"data_numeric": {
"format": "double",
"nullable": true,
"type": "number"
},
"part": {
"description": "Parent Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template",
"template_detail"
],
"type": "object"
}
GET /api/part/parameter/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/part/parameter/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/part/parameter/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/part/related/¶
Description
API endpoint for accessing a list of PartRelated objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PartRelation"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/related/¶
Description
API endpoint for accessing a list of PartRelated objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
Response 201 Created
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
DELETE /api/part/related/{id}/¶
Description
API endpoint for accessing detail view of a PartRelated object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/related/{id}/¶
Description
API endpoint for accessing detail view of a PartRelated object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
PATCH /api/part/related/{id}/¶
Description
API endpoint for accessing detail view of a PartRelated object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"type": "object"
}
Response 200 OK
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
PUT /api/part/related/{id}/¶
Description
API endpoint for accessing detail view of a PartRelated object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the request body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
Response 200 OK
{
"part_1": 0,
"part_1_detail": null,
"part_2": 0,
"part_2_detail": null,
"pk": 0
}
Schema of the response body
{
"description": "Serializer for a PartRelated model.",
"properties": {
"part_1": {
"type": "integer"
},
"part_1_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"part_2": {
"description": "Select Related Part",
"type": "integer"
},
"part_2_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Part"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
}
},
"required": [
"part_1",
"part_1_detail",
"part_2",
"part_2_detail",
"pk"
],
"type": "object"
}
GET /api/part/related/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/part/related/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/part/related/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/part/sale-price/¶
Description
API endpoint for list view of PartSalePriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | ||
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PartSalePrice"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/sale-price/¶
Description
API endpoint for list view of PartSalePriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
Response 201 Created
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
DELETE /api/part/sale-price/{id}/¶
Description
Detail endpoint for PartSellPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/sale-price/{id}/¶
Description
Detail endpoint for PartSellPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
PATCH /api/part/sale-price/{id}/¶
Description
Detail endpoint for PartSellPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
Response 200 OK
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
PUT /api/part/sale-price/{id}/¶
Description
Detail endpoint for PartSellPriceBreak model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the request body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
Response 200 OK
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12
}
Schema of the response body
{
"description": "Serializer for sale prices for Part model.",
"properties": {
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
GET /api/part/stocktake/¶
Description
API endpoint for listing part stocktake information.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | ||
user |
query | integer | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PartStocktake"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/stocktake/¶
Description
API endpoint for listing part stocktake information.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part",
"pk",
"quantity",
"user",
"user_detail"
],
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part",
"pk",
"quantity",
"user",
"user_detail"
],
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part",
"pk",
"quantity",
"user",
"user_detail"
],
"type": "object"
}
Response 201 Created
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part",
"pk",
"quantity",
"user",
"user_detail"
],
"type": "object"
}
GET /api/part/stocktake/report/¶
Description
API endpoint for listing part stocktake report information.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"date": "2022-04-13",
"part_count": 0,
"pk": 0,
"report": "string",
"user": 0,
"user_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PartStocktakeReport"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/stocktake/report/generate/¶
Description
API endpoint for manually generating a new PartStocktakeReport.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"category": 0,
"exclude_external": true,
"generate_report": true,
"location": 0,
"part": 0,
"update_parts": true
}
Schema of the request body
{
"description": "Serializer class for manually generating a new PartStocktakeReport via the API.",
"properties": {
"category": {
"description": "Limit stocktake report to a particular part category, and any child categories",
"nullable": true,
"type": "integer"
},
"exclude_external": {
"default": true,
"description": "Exclude stock items in external locations",
"title": "Exclude External Stock",
"type": "boolean"
},
"generate_report": {
"default": true,
"description": "Generate report file containing calculated stocktake data",
"type": "boolean"
},
"location": {
"description": "Limit stocktake report to a particular stock location, and any child locations",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Limit stocktake report to a particular part, and any variant parts",
"nullable": true,
"type": "integer"
},
"update_parts": {
"default": true,
"description": "Update specified parts with calculated stocktake data",
"type": "boolean"
}
},
"type": "object"
}
{
"category": 0,
"exclude_external": true,
"generate_report": true,
"location": 0,
"part": 0,
"update_parts": true
}
Schema of the request body
{
"description": "Serializer class for manually generating a new PartStocktakeReport via the API.",
"properties": {
"category": {
"description": "Limit stocktake report to a particular part category, and any child categories",
"nullable": true,
"type": "integer"
},
"exclude_external": {
"default": true,
"description": "Exclude stock items in external locations",
"title": "Exclude External Stock",
"type": "boolean"
},
"generate_report": {
"default": true,
"description": "Generate report file containing calculated stocktake data",
"type": "boolean"
},
"location": {
"description": "Limit stocktake report to a particular stock location, and any child locations",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Limit stocktake report to a particular part, and any variant parts",
"nullable": true,
"type": "integer"
},
"update_parts": {
"default": true,
"description": "Update specified parts with calculated stocktake data",
"type": "boolean"
}
},
"type": "object"
}
{
"category": 0,
"exclude_external": true,
"generate_report": true,
"location": 0,
"part": 0,
"update_parts": true
}
Schema of the request body
{
"description": "Serializer class for manually generating a new PartStocktakeReport via the API.",
"properties": {
"category": {
"description": "Limit stocktake report to a particular part category, and any child categories",
"nullable": true,
"type": "integer"
},
"exclude_external": {
"default": true,
"description": "Exclude stock items in external locations",
"title": "Exclude External Stock",
"type": "boolean"
},
"generate_report": {
"default": true,
"description": "Generate report file containing calculated stocktake data",
"type": "boolean"
},
"location": {
"description": "Limit stocktake report to a particular stock location, and any child locations",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Limit stocktake report to a particular part, and any variant parts",
"nullable": true,
"type": "integer"
},
"update_parts": {
"default": true,
"description": "Update specified parts with calculated stocktake data",
"type": "boolean"
}
},
"type": "object"
}
Response 201 Created
{
"category": 0,
"exclude_external": true,
"generate_report": true,
"location": 0,
"part": 0,
"update_parts": true
}
Schema of the response body
{
"description": "Serializer class for manually generating a new PartStocktakeReport via the API.",
"properties": {
"category": {
"description": "Limit stocktake report to a particular part category, and any child categories",
"nullable": true,
"type": "integer"
},
"exclude_external": {
"default": true,
"description": "Exclude stock items in external locations",
"title": "Exclude External Stock",
"type": "boolean"
},
"generate_report": {
"default": true,
"description": "Generate report file containing calculated stocktake data",
"type": "boolean"
},
"location": {
"description": "Limit stocktake report to a particular stock location, and any child locations",
"nullable": true,
"type": "integer"
},
"part": {
"description": "Limit stocktake report to a particular part, and any variant parts",
"nullable": true,
"type": "integer"
},
"update_parts": {
"default": true,
"description": "Update specified parts with calculated stocktake data",
"type": "boolean"
}
},
"type": "object"
}
DELETE /api/part/stocktake/{id}/¶
Description
Detail API endpoint for a single PartStocktake instance.
Note: Only staff (admin) users can access this endpoint.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/stocktake/{id}/¶
Description
Detail API endpoint for a single PartStocktake instance.
Note: Only staff (admin) users can access this endpoint.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part",
"pk",
"quantity",
"user",
"user_detail"
],
"type": "object"
}
PATCH /api/part/stocktake/{id}/¶
Description
Detail API endpoint for a single PartStocktake instance.
Note: Only staff (admin) users can access this endpoint.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part",
"pk",
"quantity",
"user",
"user_detail"
],
"type": "object"
}
PUT /api/part/stocktake/{id}/¶
Description
Detail API endpoint for a single PartStocktake instance.
Note: Only staff (admin) users can access this endpoint.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part",
"pk",
"quantity",
"user",
"user_detail"
],
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part",
"pk",
"quantity",
"user",
"user_detail"
],
"type": "object"
}
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part",
"pk",
"quantity",
"user",
"user_detail"
],
"type": "object"
}
Response 200 OK
{
"cost_max": "string",
"cost_max_currency": null,
"cost_min": "string",
"cost_min_currency": null,
"date": "2022-04-13",
"item_count": 0,
"note": "string",
"part": 0,
"pk": 0,
"quantity": 10.12,
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for the PartStocktake model.",
"properties": {
"cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"cost_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
"title": "Currency"
},
"date": {
"description": "Date stocktake was performed",
"format": "date",
"readOnly": true,
"type": "string"
},
"item_count": {
"description": "Number of individual stock entries at time of stocktake",
"type": "integer"
},
"note": {
"description": "Additional notes",
"maxLength": 250,
"title": "Notes",
"type": "string"
},
"part": {
"description": "Part for stocktake",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"user": {
"description": "User who performed this stocktake",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part",
"pk",
"quantity",
"user",
"user_detail"
],
"type": "object"
}
GET /api/part/test-template/¶
Description
API endpoint for listing (and creating) a PartTestTemplate.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
enabled |
query | boolean | No | ||
has_results |
query | boolean | No | Has Results | |
key |
query | string | No | ||
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | Part | |
required |
query | boolean | No | ||
requires_attachment |
query | boolean | No | ||
requires_value |
query | boolean | No | ||
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PartTestTemplate"
},
"type": "array"
}
},
"type": "object"
}
POST /api/part/test-template/¶
Description
API endpoint for listing (and creating) a PartTestTemplate.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
Response 201 Created
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the response body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
DELETE /api/part/test-template/{id}/¶
Description
Detail endpoint for PartTestTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/test-template/{id}/¶
Description
Detail endpoint for PartTestTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the response body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
PATCH /api/part/test-template/{id}/¶
Description
Detail endpoint for PartTestTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the response body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
PUT /api/part/test-template/{id}/¶
Description
Detail endpoint for PartTestTemplate model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the request body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
Response 200 OK
{
"description": "string",
"enabled": true,
"key": "string",
"part": 0,
"pk": 0,
"required": true,
"requires_attachment": true,
"requires_value": true,
"results": 0,
"test_name": "string"
}
Schema of the response body
{
"description": "Serializer for the PartTestTemplate class.",
"properties": {
"description": {
"description": "Enter description for this test",
"maxLength": 100,
"nullable": true,
"title": "Test Description",
"type": "string"
},
"enabled": {
"description": "Is this test enabled?",
"type": "boolean"
},
"key": {
"readOnly": true,
"type": "string"
},
"part": {
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"description": "Is this test required to pass?",
"type": "boolean"
},
"requires_attachment": {
"description": "Does this test require a file attachment when adding a test result?",
"type": "boolean"
},
"requires_value": {
"description": "Does this test require a value when adding a test result?",
"type": "boolean"
},
"results": {
"description": "Number of results recorded against this template",
"readOnly": true,
"type": "integer"
},
"test_name": {
"description": "Enter a name for the test",
"maxLength": 100,
"type": "string"
}
},
"required": [
"key",
"part",
"pk",
"results",
"test_name"
],
"type": "object"
}
GET /api/part/test-template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/part/test-template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/part/test-template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/part/thumbs/¶
Description
API endpoint for retrieving information on available Part thumbnails.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"count": 0,
"image": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PartThumb"
},
"type": "array"
}
},
"type": "object"
}
GET /api/part/thumbs/{id}/¶
Description
API endpoint for updating Part thumbnails.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | string | No |
Response 200 OK
{
"image": "string"
}
Schema of the response body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
PATCH /api/part/thumbs/{id}/¶
Description
API endpoint for updating Part thumbnails.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | string | No |
Request body
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"image": "string"
}
Schema of the response body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
PUT /api/part/thumbs/{id}/¶
Description
API endpoint for updating Part thumbnails.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | string | No |
Request body
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
{
"image": "string"
}
Schema of the request body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
Response 200 OK
{
"image": "string"
}
Schema of the response body
{
"description": "Serializer for updating Part thumbnail.",
"properties": {
"image": {
"format": "uri",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
}
DELETE /api/part/{id}/¶
Description
API endpoint for detail view of a single Part object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/part/{id}/¶
Description
API endpoint for detail view of a single Part object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the response body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"barcode_hash",
"building",
"category",
"category_default_location",
"creation_date",
"external_stock",
"full_name",
"in_stock",
"minimum_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
PATCH /api/part/{id}/¶
Description
API endpoint for detail view of a single Part object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"pricing_max": "string",
"pricing_min": "string",
"pricing_updated": "2022-04-13T15:42:05.901Z",
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pricing_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"pricing_updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"type": "object"
}
Response 200 OK
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the response body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"barcode_hash",
"building",
"category",
"category_default_location",
"creation_date",
"external_stock",
"full_name",
"in_stock",
"minimum_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
PUT /api/part/{id}/¶
Description
API endpoint for detail view of a single Part object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"barcode_hash",
"building",
"category",
"category_default_location",
"creation_date",
"external_stock",
"full_name",
"in_stock",
"minimum_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"barcode_hash",
"building",
"category",
"category_default_location",
"creation_date",
"external_stock",
"full_name",
"in_stock",
"minimum_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the request body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"barcode_hash",
"building",
"category",
"category_default_location",
"creation_date",
"external_stock",
"full_name",
"in_stock",
"minimum_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
Response 200 OK
{
"IPN": "string",
"active": true,
"allocated_to_build_orders": 10.12,
"allocated_to_sales_orders": 10.12,
"assembly": true,
"barcode_hash": "string",
"building": 10.12,
"category": 0,
"category_default_location": 0,
"component": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_supplier": 0,
"description": "string",
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"pk": 0,
"purchaseable": true,
"remote_image": "string",
"required_for_build_orders": 0,
"required_for_sales_orders": 0,
"responsible": 0,
"revision": "string",
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"thumbnail": "string",
"total_in_stock": 10.12,
"trackable": true,
"unallocated_stock": 10.12,
"units": "string",
"variant_of": 0,
"variant_stock": 10.12,
"virtual": true
}
Schema of the response body
{
"description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
"properties": {
"IPN": {
"description": "Internal Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"active": {
"description": "Is this part active?",
"type": "boolean"
},
"allocated_to_build_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocated_to_sales_orders": {
"format": "double",
"readOnly": true,
"type": "number"
},
"assembly": {
"description": "Can this part be built from other parts?",
"type": "boolean"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"building": {
"format": "double",
"readOnly": true,
"type": "number"
},
"category": {
"type": "integer"
},
"category_default_location": {
"readOnly": true,
"type": "integer"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"creation_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"creation_user": {
"nullable": true,
"type": "integer"
},
"default_expiry": {
"description": "Expiry time (in days) for stock items of this part",
"minimum": 0,
"type": "integer"
},
"default_location": {
"description": "Where is this item normally stored?",
"nullable": true,
"type": "integer"
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"existing_image": {
"description": "Filename of an existing part image",
"type": "string",
"writeOnly": true
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"full_name": {
"description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
"readOnly": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"is_template": {
"description": "Is this part a template part?",
"type": "boolean"
},
"keywords": {
"description": "Part keywords to improve visibility in search results",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"last_stocktake": {
"format": "date",
"nullable": true,
"type": "string"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"minimum_stock": {
"format": "double",
"type": "number"
},
"name": {
"description": "Part name",
"maxLength": 100,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"ordering": {
"format": "double",
"readOnly": true,
"title": "On Order",
"type": "number"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchaseable": {
"description": "Can this part be purchased from external suppliers?",
"type": "boolean"
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"required_for_build_orders": {
"readOnly": true,
"type": "integer"
},
"required_for_sales_orders": {
"readOnly": true,
"type": "integer"
},
"responsible": {
"nullable": true,
"type": "integer"
},
"revision": {
"description": "Part revision or version number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"salable": {
"description": "Can this part be sold to customers?",
"type": "boolean"
},
"starred": {
"description": "Return \"true\" if the part is starred by the current user.",
"readOnly": true,
"type": "boolean"
},
"stock_item_count": {
"readOnly": true,
"title": "Stock Items",
"type": "integer"
},
"suppliers": {
"readOnly": true,
"type": "integer"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"thumbnail": {
"readOnly": true,
"type": "string"
},
"total_in_stock": {
"format": "double",
"readOnly": true,
"title": "Total Stock",
"type": "number"
},
"trackable": {
"description": "Does this part have tracking for unique items?",
"type": "boolean"
},
"unallocated_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"units": {
"description": "Units of measure for this part",
"maxLength": 20,
"nullable": true,
"type": "string"
},
"variant_of": {
"description": "Is this part a variant of another part?",
"nullable": true,
"type": "integer"
},
"variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"virtual": {
"description": "Is this a virtual part, such as a software product or license?",
"type": "boolean"
}
},
"required": [
"allocated_to_build_orders",
"allocated_to_sales_orders",
"barcode_hash",
"building",
"category",
"category_default_location",
"creation_date",
"external_stock",
"full_name",
"in_stock",
"minimum_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
POST /api/part/{id}/bom-copy/¶
Description
API endpoint for duplicating a BOM.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"copy_substitutes": true,
"include_inherited": true,
"part": 0,
"remove_existing": true,
"skip_invalid": true
}
Schema of the request body
{
"description": "Serializer for copying a BOM from another part.",
"properties": {
"copy_substitutes": {
"default": true,
"description": "Copy substitute parts when duplicate BOM items",
"title": "Copy Substitute Parts",
"type": "boolean"
},
"include_inherited": {
"default": false,
"description": "Include BOM items which are inherited from templated parts",
"type": "boolean"
},
"part": {
"description": "Select part to copy BOM from",
"type": "integer"
},
"remove_existing": {
"default": true,
"description": "Remove existing BOM items before copying",
"title": "Remove Existing Data",
"type": "boolean"
},
"skip_invalid": {
"default": false,
"description": "Enable this option to skip invalid rows",
"title": "Skip Invalid Rows",
"type": "boolean"
}
},
"required": [
"part"
],
"type": "object"
}
{
"copy_substitutes": true,
"include_inherited": true,
"part": 0,
"remove_existing": true,
"skip_invalid": true
}
Schema of the request body
{
"description": "Serializer for copying a BOM from another part.",
"properties": {
"copy_substitutes": {
"default": true,
"description": "Copy substitute parts when duplicate BOM items",
"title": "Copy Substitute Parts",
"type": "boolean"
},
"include_inherited": {
"default": false,
"description": "Include BOM items which are inherited from templated parts",
"type": "boolean"
},
"part": {
"description": "Select part to copy BOM from",
"type": "integer"
},
"remove_existing": {
"default": true,
"description": "Remove existing BOM items before copying",
"title": "Remove Existing Data",
"type": "boolean"
},
"skip_invalid": {
"default": false,
"description": "Enable this option to skip invalid rows",
"title": "Skip Invalid Rows",
"type": "boolean"
}
},
"required": [
"part"
],
"type": "object"
}
{
"copy_substitutes": true,
"include_inherited": true,
"part": 0,
"remove_existing": true,
"skip_invalid": true
}
Schema of the request body
{
"description": "Serializer for copying a BOM from another part.",
"properties": {
"copy_substitutes": {
"default": true,
"description": "Copy substitute parts when duplicate BOM items",
"title": "Copy Substitute Parts",
"type": "boolean"
},
"include_inherited": {
"default": false,
"description": "Include BOM items which are inherited from templated parts",
"type": "boolean"
},
"part": {
"description": "Select part to copy BOM from",
"type": "integer"
},
"remove_existing": {
"default": true,
"description": "Remove existing BOM items before copying",
"title": "Remove Existing Data",
"type": "boolean"
},
"skip_invalid": {
"default": false,
"description": "Enable this option to skip invalid rows",
"title": "Skip Invalid Rows",
"type": "boolean"
}
},
"required": [
"part"
],
"type": "object"
}
Response 201 Created
{
"copy_substitutes": true,
"include_inherited": true,
"part": 0,
"remove_existing": true,
"skip_invalid": true
}
Schema of the response body
{
"description": "Serializer for copying a BOM from another part.",
"properties": {
"copy_substitutes": {
"default": true,
"description": "Copy substitute parts when duplicate BOM items",
"title": "Copy Substitute Parts",
"type": "boolean"
},
"include_inherited": {
"default": false,
"description": "Include BOM items which are inherited from templated parts",
"type": "boolean"
},
"part": {
"description": "Select part to copy BOM from",
"type": "integer"
},
"remove_existing": {
"default": true,
"description": "Remove existing BOM items before copying",
"title": "Remove Existing Data",
"type": "boolean"
},
"skip_invalid": {
"default": false,
"description": "Enable this option to skip invalid rows",
"title": "Skip Invalid Rows",
"type": "boolean"
}
},
"required": [
"part"
],
"type": "object"
}
GET /api/part/{id}/bom-validate/¶
Description
API endpoint for 'validating' the BOM for a given Part.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"checksum": "string",
"valid": true
}
Schema of the response body
{
"description": "Simple serializer class for validating a single BomItem instance.",
"properties": {
"checksum": {
"readOnly": true,
"type": "string"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"checksum"
],
"type": "object"
}
PATCH /api/part/{id}/bom-validate/¶
Description
API endpoint for 'validating' the BOM for a given Part.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"checksum": "string",
"valid": true
}
Schema of the request body
{
"description": "Simple serializer class for validating a single BomItem instance.",
"properties": {
"checksum": {
"readOnly": true,
"type": "string"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"type": "object"
}
{
"checksum": "string",
"valid": true
}
Schema of the request body
{
"description": "Simple serializer class for validating a single BomItem instance.",
"properties": {
"checksum": {
"readOnly": true,
"type": "string"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"type": "object"
}
{
"checksum": "string",
"valid": true
}
Schema of the request body
{
"description": "Simple serializer class for validating a single BomItem instance.",
"properties": {
"checksum": {
"readOnly": true,
"type": "string"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"checksum": "string",
"valid": true
}
Schema of the response body
{
"description": "Simple serializer class for validating a single BomItem instance.",
"properties": {
"checksum": {
"readOnly": true,
"type": "string"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"checksum"
],
"type": "object"
}
PUT /api/part/{id}/bom-validate/¶
Description
API endpoint for 'validating' the BOM for a given Part.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"checksum": "string",
"valid": true
}
Schema of the request body
{
"description": "Simple serializer class for validating a single BomItem instance.",
"properties": {
"checksum": {
"readOnly": true,
"type": "string"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"checksum"
],
"type": "object"
}
{
"checksum": "string",
"valid": true
}
Schema of the request body
{
"description": "Simple serializer class for validating a single BomItem instance.",
"properties": {
"checksum": {
"readOnly": true,
"type": "string"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"checksum"
],
"type": "object"
}
{
"checksum": "string",
"valid": true
}
Schema of the request body
{
"description": "Simple serializer class for validating a single BomItem instance.",
"properties": {
"checksum": {
"readOnly": true,
"type": "string"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"checksum"
],
"type": "object"
}
Response 200 OK
{
"checksum": "string",
"valid": true
}
Schema of the response body
{
"description": "Simple serializer class for validating a single BomItem instance.",
"properties": {
"checksum": {
"readOnly": true,
"type": "string"
},
"valid": {
"default": false,
"description": "Validate entire Bill of Materials",
"type": "boolean",
"writeOnly": true
}
},
"required": [
"checksum"
],
"type": "object"
}
GET /api/part/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/part/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/part/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/part/{id}/pricing/¶
Description
API endpoint for viewing part pricing data.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": null,
"override_min": "string",
"override_min_currency": null,
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the response body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Maximum price currency"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Minimum price currency"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"bom_cost_max",
"bom_cost_min",
"currency",
"internal_cost_max",
"internal_cost_min",
"overall_max",
"overall_min",
"purchase_cost_max",
"purchase_cost_min",
"sale_history_max",
"sale_history_min",
"sale_price_max",
"sale_price_min",
"scheduled_for_update",
"supplier_price_max",
"supplier_price_min",
"updated",
"variant_cost_max",
"variant_cost_min"
],
"type": "object"
}
PATCH /api/part/{id}/pricing/¶
Description
API endpoint for viewing part pricing data.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": null,
"override_min": "string",
"override_min_currency": null,
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Maximum price currency"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Minimum price currency"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": null,
"override_min": "string",
"override_min_currency": null,
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Maximum price currency"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Minimum price currency"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": null,
"override_min": "string",
"override_min_currency": null,
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Maximum price currency"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Minimum price currency"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": null,
"override_min": "string",
"override_min_currency": null,
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the response body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Maximum price currency"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Minimum price currency"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"bom_cost_max",
"bom_cost_min",
"currency",
"internal_cost_max",
"internal_cost_min",
"overall_max",
"overall_min",
"purchase_cost_max",
"purchase_cost_min",
"sale_history_max",
"sale_history_min",
"sale_price_max",
"sale_price_min",
"scheduled_for_update",
"supplier_price_max",
"supplier_price_min",
"updated",
"variant_cost_max",
"variant_cost_min"
],
"type": "object"
}
PUT /api/part/{id}/pricing/¶
Description
API endpoint for viewing part pricing data.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": null,
"override_min": "string",
"override_min_currency": null,
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Maximum price currency"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Minimum price currency"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"bom_cost_max",
"bom_cost_min",
"currency",
"internal_cost_max",
"internal_cost_min",
"overall_max",
"overall_min",
"purchase_cost_max",
"purchase_cost_min",
"sale_history_max",
"sale_history_min",
"sale_price_max",
"sale_price_min",
"scheduled_for_update",
"supplier_price_max",
"supplier_price_min",
"updated",
"variant_cost_max",
"variant_cost_min"
],
"type": "object"
}
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": null,
"override_min": "string",
"override_min_currency": null,
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Maximum price currency"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Minimum price currency"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"bom_cost_max",
"bom_cost_min",
"currency",
"internal_cost_max",
"internal_cost_min",
"overall_max",
"overall_min",
"purchase_cost_max",
"purchase_cost_min",
"sale_history_max",
"sale_history_min",
"sale_price_max",
"sale_price_min",
"scheduled_for_update",
"supplier_price_max",
"supplier_price_min",
"updated",
"variant_cost_max",
"variant_cost_min"
],
"type": "object"
}
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": null,
"override_min": "string",
"override_min_currency": null,
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the request body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Maximum price currency"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Minimum price currency"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"bom_cost_max",
"bom_cost_min",
"currency",
"internal_cost_max",
"internal_cost_min",
"overall_max",
"overall_min",
"purchase_cost_max",
"purchase_cost_min",
"sale_history_max",
"sale_history_min",
"sale_price_max",
"sale_price_min",
"scheduled_for_update",
"supplier_price_max",
"supplier_price_min",
"updated",
"variant_cost_max",
"variant_cost_min"
],
"type": "object"
}
Response 200 OK
{
"bom_cost_max": "string",
"bom_cost_min": "string",
"currency": "string",
"internal_cost_max": "string",
"internal_cost_min": "string",
"overall_max": "string",
"overall_min": "string",
"override_max": "string",
"override_max_currency": null,
"override_min": "string",
"override_min_currency": null,
"purchase_cost_max": "string",
"purchase_cost_min": "string",
"sale_history_max": "string",
"sale_history_min": "string",
"sale_price_max": "string",
"sale_price_min": "string",
"scheduled_for_update": true,
"supplier_price_max": "string",
"supplier_price_min": "string",
"update": true,
"updated": "2022-04-13T15:42:05.901Z",
"variant_cost_max": "string",
"variant_cost_min": "string"
}
Schema of the response body
{
"description": "Serializer for Part pricing information.",
"properties": {
"bom_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"bom_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"currency": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"internal_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"internal_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"overall_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"override_max": {
"description": "Override calculated value for maximum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Maximum Price",
"type": "string"
},
"override_max_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Maximum price currency"
},
"override_min": {
"description": "Override calculated value for minimum price",
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"title": "Minimum Price",
"type": "string"
},
"override_min_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"title": "Minimum price currency"
},
"purchase_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"purchase_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_history_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"sale_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"scheduled_for_update": {
"readOnly": true,
"type": "boolean"
},
"supplier_price_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"supplier_price_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"update": {
"default": false,
"description": "Update pricing for this part",
"nullable": true,
"type": "boolean",
"writeOnly": true
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variant_cost_max": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
},
"variant_cost_min": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"bom_cost_max",
"bom_cost_min",
"currency",
"internal_cost_max",
"internal_cost_min",
"overall_max",
"overall_min",
"purchase_cost_max",
"purchase_cost_min",
"sale_history_max",
"sale_history_min",
"sale_price_max",
"sale_price_min",
"scheduled_for_update",
"supplier_price_max",
"supplier_price_min",
"updated",
"variant_cost_max",
"variant_cost_min"
],
"type": "object"
}
GET /api/part/{id}/requirements/¶
Description
API endpoint detailing 'requirements' information for a particular part.
This endpoint returns information on upcoming requirements for:
- Sales Orders
- Build Orders
- Total requirements
As this data is somewhat complex to calculate, is it not included in the default API
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
GET /api/part/{id}/scheduling/¶
Description
API endpoint for delivering "scheduling" information about a given part via the API.
Returns a chronologically ordered list about future "scheduled" events, concerning stock levels for the part:
- Purchase Orders (incoming stock)
- Sales Orders (outgoing stock)
- Build Orders (incoming completed stock)
- Build Orders (outgoing allocated stock)
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
GET /api/part/{id}/serial-numbers/¶
Description
API endpoint for returning extra serial number information about a particular part.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
Schemas¶
BOMValidate¶
| Name | Type |
|---|---|
checksum |
string |
valid |
boolean |
Category¶
| Name | Type |
|---|---|
default_keywords |
string| null |
default_location |
integer| null |
description |
string |
icon |
string |
level |
integer |
name |
string |
parent |
integer| null |
parent_default_location |
integer |
part_count |
integer |
pathstring |
string |
pk |
integer |
starred |
boolean |
structural |
boolean |
subcategories |
integer |
url |
string |
CategoryParameterTemplate¶
| Name | Type |
|---|---|
category |
integer |
category_detail |
|
default_value |
string |
parameter_template |
integer |
parameter_template_detail |
|
pk |
integer |
CategoryTree¶
| Name | Type |
|---|---|
icon |
string |
name |
string |
parent |
integer| null |
pk |
integer |
structural |
boolean |
subcategories |
integer |
Metadata¶
| Name | Type |
|---|---|
metadata |
PaginatedCategoryList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<Category> |
PaginatedCategoryParameterTemplateList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<CategoryParameterTemplate> |
PaginatedCategoryTreeList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<CategoryTree> |
PaginatedPartAttachmentList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PartAttachment> |
PaginatedPartInternalPriceList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PartInternalPrice> |
PaginatedPartList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<Part> |
PaginatedPartParameterList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PartParameter> |
PaginatedPartParameterTemplateList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PartParameterTemplate> |
PaginatedPartRelationList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PartRelation> |
PaginatedPartSalePriceList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PartSalePrice> |
PaginatedPartStocktakeList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PartStocktake> |
PaginatedPartStocktakeReportList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PartStocktakeReport> |
PaginatedPartTestTemplateList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PartTestTemplate> |
PaginatedPartThumbList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PartThumb> |
Part¶
| Name | Type |
|---|---|
active |
boolean |
allocated_to_build_orders |
number(double) |
allocated_to_sales_orders |
number(double) |
assembly |
boolean |
barcode_hash |
string |
building |
number(double) |
category |
integer |
category_default_location |
integer |
component |
boolean |
creation_date |
string(date)| null |
creation_user |
integer| null |
default_expiry |
integer |
default_location |
integer| null |
default_supplier |
integer| null |
description |
string |
existing_image |
string |
external_stock |
number(double) |
full_name |
string |
image |
string(uri)| null |
in_stock |
number(double) |
IPN |
string| null |
is_template |
boolean |
keywords |
string| null |
last_stocktake |
string(date)| null |
link |
string(uri)| null |
minimum_stock |
number(double) |
name |
string |
notes |
string| null |
ordering |
number(double) |
pk |
integer |
purchaseable |
boolean |
remote_image |
string(uri) |
required_for_build_orders |
integer |
required_for_sales_orders |
integer |
responsible |
integer| null |
revision |
string| null |
salable |
boolean |
starred |
boolean |
stock_item_count |
integer |
suppliers |
integer |
tags |
Array<string> |
thumbnail |
string |
total_in_stock |
number(double) |
trackable |
boolean |
unallocated_stock |
number(double) |
units |
string| null |
variant_of |
integer| null |
variant_stock |
number(double) |
virtual |
boolean |
PartAttachment¶
| Name | Type |
|---|---|
attachment |
string(uri) |
comment |
string |
filename |
string |
link |
string(uri)| null |
part |
integer |
pk |
integer |
upload_date |
string(date) |
user |
integer| null |
user_detail |
PartCopyBOM¶
| Name | Type |
|---|---|
copy_substitutes |
boolean |
include_inherited |
boolean |
part |
integer |
remove_existing |
boolean |
skip_invalid |
boolean |
PartInternalPrice¶
| Name | Type |
|---|---|
part |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
PartParameter¶
| Name | Type |
|---|---|
data |
string |
data_numeric |
number(double)| null |
part |
integer |
pk |
integer |
template |
integer |
template_detail |
PartParameterTemplate¶
| Name | Type |
|---|---|
checkbox |
boolean |
choices |
string |
description |
string |
name |
string |
parts |
integer |
pk |
integer |
units |
string |
PartPricing¶
| Name | Type |
|---|---|
bom_cost_max |
string(decimal)| null |
bom_cost_min |
string(decimal)| null |
currency |
string| null |
internal_cost_max |
string(decimal)| null |
internal_cost_min |
string(decimal)| null |
overall_max |
string(decimal)| null |
overall_min |
string(decimal)| null |
override_max |
string(decimal)| null |
override_max_currency |
|
override_min |
string(decimal)| null |
override_min_currency |
|
purchase_cost_max |
string(decimal)| null |
purchase_cost_min |
string(decimal)| null |
sale_history_max |
string(decimal)| null |
sale_history_min |
string(decimal)| null |
sale_price_max |
string(decimal)| null |
sale_price_min |
string(decimal)| null |
scheduled_for_update |
boolean |
supplier_price_max |
string(decimal)| null |
supplier_price_min |
string(decimal)| null |
update |
boolean| null |
updated |
string(date-time)| null |
variant_cost_max |
string(decimal)| null |
variant_cost_min |
string(decimal)| null |
PartRelation¶
| Name | Type |
|---|---|
part_1 |
integer |
part_1_detail |
|
part_2 |
integer |
part_2_detail |
|
pk |
integer |
PartSalePrice¶
| Name | Type |
|---|---|
part |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
PartSetCategory¶
| Name | Type |
|---|---|
category |
integer |
parts |
Array<integer> |
PartStocktake¶
| Name | Type |
|---|---|
cost_max |
string(decimal)| null |
cost_max_currency |
|
cost_min |
string(decimal)| null |
cost_min_currency |
|
date |
string(date) |
item_count |
integer |
note |
string |
part |
integer |
pk |
integer |
quantity |
number(double) |
user |
integer| null |
user_detail |
PartStocktakeReport¶
| Name | Type |
|---|---|
date |
string(date) |
part_count |
integer |
pk |
integer |
report |
string(uri) |
user |
integer| null |
user_detail |
PartStocktakeReportGenerate¶
| Name | Type |
|---|---|
category |
integer| null |
exclude_external |
boolean |
generate_report |
boolean |
location |
integer| null |
part |
integer| null |
update_parts |
boolean |
PartTestTemplate¶
| Name | Type |
|---|---|
description |
string| null |
enabled |
boolean |
key |
string |
part |
integer |
pk |
integer |
required |
boolean |
requires_attachment |
boolean |
requires_value |
boolean |
results |
integer |
test_name |
string |
PartThumb¶
| Name | Type |
|---|---|
count |
integer |
image |
string(uri) |
PartThumbSerializerUpdate¶
| Name | Type |
|---|---|
image |
string(uri) |
PatchedBOMValidate¶
| Name | Type |
|---|---|
checksum |
string |
valid |
boolean |
PatchedCategory¶
| Name | Type |
|---|---|
default_keywords |
string| null |
default_location |
integer| null |
description |
string |
icon |
string |
level |
integer |
name |
string |
parent |
integer| null |
parent_default_location |
integer |
part_count |
integer |
pathstring |
string |
pk |
integer |
starred |
boolean |
structural |
boolean |
subcategories |
integer |
url |
string |
PatchedCategoryParameterTemplate¶
| Name | Type |
|---|---|
category |
integer |
category_detail |
|
default_value |
string |
parameter_template |
integer |
parameter_template_detail |
|
pk |
integer |
PatchedMetadata¶
| Name | Type |
|---|---|
metadata |
PatchedPart¶
| Name | Type |
|---|---|
active |
boolean |
allocated_to_build_orders |
number(double) |
allocated_to_sales_orders |
number(double) |
assembly |
boolean |
barcode_hash |
string |
building |
number(double) |
category |
integer |
category_default_location |
integer |
component |
boolean |
creation_date |
string(date)| null |
creation_user |
integer| null |
default_expiry |
integer |
default_location |
integer| null |
default_supplier |
integer| null |
description |
string |
existing_image |
string |
external_stock |
number(double) |
full_name |
string |
image |
string(uri)| null |
in_stock |
number(double) |
IPN |
string| null |
is_template |
boolean |
keywords |
string| null |
last_stocktake |
string(date)| null |
link |
string(uri)| null |
minimum_stock |
number(double) |
name |
string |
notes |
string| null |
ordering |
number(double) |
pk |
integer |
pricing_max |
string(decimal)| null |
pricing_min |
string(decimal)| null |
pricing_updated |
string(date-time)| null |
purchaseable |
boolean |
remote_image |
string(uri) |
required_for_build_orders |
integer |
required_for_sales_orders |
integer |
responsible |
integer| null |
revision |
string| null |
salable |
boolean |
starred |
boolean |
stock_item_count |
integer |
suppliers |
integer |
tags |
Array<string> |
thumbnail |
string |
total_in_stock |
number(double) |
trackable |
boolean |
unallocated_stock |
number(double) |
units |
string| null |
variant_of |
integer| null |
variant_stock |
number(double) |
virtual |
boolean |
PatchedPartAttachment¶
| Name | Type |
|---|---|
attachment |
string(uri) |
comment |
string |
filename |
string |
link |
string(uri)| null |
part |
integer |
pk |
integer |
upload_date |
string(date) |
user |
integer| null |
user_detail |
PatchedPartInternalPrice¶
| Name | Type |
|---|---|
part |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
PatchedPartParameter¶
| Name | Type |
|---|---|
data |
string |
data_numeric |
number(double)| null |
part |
integer |
pk |
integer |
template |
integer |
template_detail |
PatchedPartParameterTemplate¶
| Name | Type |
|---|---|
checkbox |
boolean |
choices |
string |
description |
string |
name |
string |
parts |
integer |
pk |
integer |
units |
string |
PatchedPartPricing¶
| Name | Type |
|---|---|
bom_cost_max |
string(decimal)| null |
bom_cost_min |
string(decimal)| null |
currency |
string| null |
internal_cost_max |
string(decimal)| null |
internal_cost_min |
string(decimal)| null |
overall_max |
string(decimal)| null |
overall_min |
string(decimal)| null |
override_max |
string(decimal)| null |
override_max_currency |
|
override_min |
string(decimal)| null |
override_min_currency |
|
purchase_cost_max |
string(decimal)| null |
purchase_cost_min |
string(decimal)| null |
sale_history_max |
string(decimal)| null |
sale_history_min |
string(decimal)| null |
sale_price_max |
string(decimal)| null |
sale_price_min |
string(decimal)| null |
scheduled_for_update |
boolean |
supplier_price_max |
string(decimal)| null |
supplier_price_min |
string(decimal)| null |
update |
boolean| null |
updated |
string(date-time)| null |
variant_cost_max |
string(decimal)| null |
variant_cost_min |
string(decimal)| null |
PatchedPartRelation¶
| Name | Type |
|---|---|
part_1 |
integer |
part_1_detail |
|
part_2 |
integer |
part_2_detail |
|
pk |
integer |
PatchedPartSalePrice¶
| Name | Type |
|---|---|
part |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
PatchedPartStocktake¶
| Name | Type |
|---|---|
cost_max |
string(decimal)| null |
cost_max_currency |
|
cost_min |
string(decimal)| null |
cost_min_currency |
|
date |
string(date) |
item_count |
integer |
note |
string |
part |
integer |
pk |
integer |
quantity |
number(double) |
user |
integer| null |
user_detail |
PatchedPartTestTemplate¶
| Name | Type |
|---|---|
description |
string| null |
enabled |
boolean |
key |
string |
part |
integer |
pk |
integer |
required |
boolean |
requires_attachment |
boolean |
requires_value |
boolean |
results |
integer |
test_name |
string |
PatchedPartThumbSerializerUpdate¶
| Name | Type |
|---|---|
image |
string(uri) |
SalePriceCurrencyEnum¶
Type: string
User¶
| Name | Type |
|---|---|
email |
string(email) |
first_name |
string |
last_name |
string |
pk |
integer |
username |
string |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| tokenAuth | apiKey | Token-based authentication with required prefix "Token" |
More documentation¶
More information about InvenTree in the official docs
For more information: https://docs.inventree.org