The Parts and Part Categories section of the InvenTree API schema is documented below.
InvenTree API 327¶
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
Override the GET method to determine export options.
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 | ||
bom_valid |
query | boolean | No | BOM Valid | |
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_revisions |
query | boolean | No | Has Revisions | |
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_revision |
query | boolean | No | Is Revision | |
is_template |
query | boolean | No | ||
is_variant |
query | boolean | No | Is Variant | |
limit |
query | integer | No | Number of results to return per page. | |
locked |
query | boolean | No | ||
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 | ||
revision_of |
query | integer | No | ||
salable |
query | boolean | No | ||
search |
query | string | No | A search term. | |
starred |
query | boolean | No | Starred | |
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 | ||
testable |
query | boolean | 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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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"
}
PATCH /api/part/¶
Description
Perform a PATCH operation against this list endpoint.
Note that the typical DRF list endpoint does not support PATCH, so this method is provided as a custom implementation.
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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
PUT /api/part/¶
Description
Perform a PUT operation against this list endpoint.
Simply redirects to the PATCH method.
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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"starred",
"stock_item_count",
"suppliers",
"thumbnail",
"total_in_stock",
"unallocated_stock",
"variant_stock"
],
"type": "object"
}
GET /api/part/category/¶
Description
Override the GET method to determine export options.
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 | ||
top_level |
query | boolean | No | Filter by top-level categories |
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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"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/Category"
},
"type": "array"
}
},
"type": "object"
}
PATCH /api/part/category/¶
Description
Perform a PATCH operation against this list endpoint.
Note that the typical DRF list endpoint does not support PATCH, so this method is provided as a custom implementation.
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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"type": "object"
}
PUT /api/part/category/¶
Description
Perform a PUT operation against this list endpoint.
Simply redirects to the PATCH method.
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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"type": "object"
}
GET /api/part/category/parameters/¶
Description
Override the GET method to determine export options.
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"
}
],
"nullable": true,
"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",
"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"
}
],
"nullable": true,
"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",
"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"
}
],
"nullable": true,
"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",
"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"
}
],
"nullable": true,
"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",
"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"
}
],
"nullable": true,
"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",
"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"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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",
"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"
}
],
"nullable": true,
"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",
"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"
}
],
"nullable": true,
"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",
"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"
}
],
"nullable": true,
"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",
"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"
}
],
"nullable": true,
"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",
"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
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 |
Response 200 OK
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 |
Response 200 OK
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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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,
"path": [
{}
],
"pathstring": "string",
"pk": 0,
"starred": true,
"structural": true,
"subcategories": 0
}
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,
"nullable": true,
"type": "string"
},
"level": {
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Name",
"maxLength": 100,
"type": "string"
},
"parent": {
"description": "Parent part category",
"nullable": true,
"title": "Parent Category",
"type": "integer"
},
"parent_default_location": {
"readOnly": true,
"type": "integer"
},
"part_count": {
"readOnly": true,
"title": "Parts",
"type": "integer"
},
"path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"pathstring": {
"description": "Path",
"readOnly": true,
"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"
}
},
"required": [
"level",
"name",
"parent_default_location",
"part_count",
"pathstring",
"pk",
"starred",
"subcategories"
],
"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
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 |
Response 200 OK
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 |
Response 200 OK
GET /api/part/internal-price/¶
Description
Override the GET method to determine export options.
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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
}
},
"required": [
"part",
"pk",
"quantity"
],
"type": "object"
}
GET /api/part/parameter/¶
Description
Override the GET method to determine export options.
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,
"part_detail": null,
"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,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template"
],
"type": "object"
}
Response 201 Created
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template"
],
"type": "object"
}
GET /api/part/parameter/template/¶
Description
Override the GET method to determine export options.
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,
"selectionlist": 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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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,
"selectionlist": 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"
},
"selectionlist": {
"description": "Selection list for this parameter",
"nullable": true,
"title": "Selection List",
"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
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 |
Response 200 OK
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 |
Response 200 OK
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,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template"
],
"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,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template"
],
"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,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template"
],
"type": "object"
}
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template"
],
"type": "object"
}
Response 200 OK
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"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"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"template": {
"description": "Parameter Template",
"type": "integer"
},
"template_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartParameterTemplate"
}
],
"nullable": true,
"readOnly": true
}
},
"required": [
"data",
"part",
"pk",
"template"
],
"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
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 |
Response 200 OK
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 |
Response 200 OK
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. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | string | No | Part | |
part_1 |
query | integer | No | ||
part_2 |
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": [
{
"note": "string",
"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
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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"
}
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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"
}
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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"
}
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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"
}
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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"
}
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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"
}
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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
{
"note": "string",
"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": {
"note": {
"description": "Note for this relationship",
"maxLength": 500,
"type": "string"
},
"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
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 |
Response 200 OK
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 |
Response 200 OK
GET /api/part/sale-price/¶
Description
Override the GET method to determine export options.
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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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_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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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_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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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_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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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_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/report/{id}/¶
Description
API endpoint for detail view of a single PartStocktakeReport 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/stocktake/report/{id}/¶
Description
API endpoint for detail view of a single PartStocktakeReport 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
{
"date": "2022-04-13",
"part_count": 0,
"pk": 0,
"report": "string",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for stocktake report class.",
"properties": {
"date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"part_count": {
"description": "Number of parts covered by stocktake",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"report": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User who requested this stocktake report",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part_count",
"pk",
"report",
"user_detail"
],
"type": "object"
}
PATCH /api/part/stocktake/report/{id}/¶
Description
API endpoint for detail view of a single PartStocktakeReport 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
{
"date": "2022-04-13",
"part_count": 0,
"pk": 0,
"report": "string",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for stocktake report class.",
"properties": {
"date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"part_count": {
"description": "Number of parts covered by stocktake",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"report": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User who requested this stocktake report",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"date": "2022-04-13",
"part_count": 0,
"pk": 0,
"report": "string",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for stocktake report class.",
"properties": {
"date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"part_count": {
"description": "Number of parts covered by stocktake",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"report": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User who requested this stocktake report",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"date": "2022-04-13",
"part_count": 0,
"pk": 0,
"report": "string",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for stocktake report class.",
"properties": {
"date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"part_count": {
"description": "Number of parts covered by stocktake",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"report": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User who requested this stocktake report",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"date": "2022-04-13",
"part_count": 0,
"pk": 0,
"report": "string",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for stocktake report class.",
"properties": {
"date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"part_count": {
"description": "Number of parts covered by stocktake",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"report": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User who requested this stocktake report",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part_count",
"pk",
"report",
"user_detail"
],
"type": "object"
}
PUT /api/part/stocktake/report/{id}/¶
Description
API endpoint for detail view of a single PartStocktakeReport 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
{
"date": "2022-04-13",
"part_count": 0,
"pk": 0,
"report": "string",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for stocktake report class.",
"properties": {
"date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"part_count": {
"description": "Number of parts covered by stocktake",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"report": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User who requested this stocktake report",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part_count",
"pk",
"report",
"user_detail"
],
"type": "object"
}
{
"date": "2022-04-13",
"part_count": 0,
"pk": 0,
"report": "string",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for stocktake report class.",
"properties": {
"date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"part_count": {
"description": "Number of parts covered by stocktake",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"report": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User who requested this stocktake report",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part_count",
"pk",
"report",
"user_detail"
],
"type": "object"
}
{
"date": "2022-04-13",
"part_count": 0,
"pk": 0,
"report": "string",
"user": 0,
"user_detail": null
}
Schema of the request body
{
"description": "Serializer for stocktake report class.",
"properties": {
"date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"part_count": {
"description": "Number of parts covered by stocktake",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"report": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User who requested this stocktake report",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part_count",
"pk",
"report",
"user_detail"
],
"type": "object"
}
Response 200 OK
{
"date": "2022-04-13",
"part_count": 0,
"pk": 0,
"report": "string",
"user": 0,
"user_detail": null
}
Schema of the response body
{
"description": "Serializer for stocktake report class.",
"properties": {
"date": {
"format": "date",
"readOnly": true,
"type": "string"
},
"part_count": {
"description": "Number of parts covered by stocktake",
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"report": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"description": "User who requested this stocktake report",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"user_detail": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"readOnly": true
}
},
"required": [
"date",
"part_count",
"pk",
"report",
"user_detail"
],
"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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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_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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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_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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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_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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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_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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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_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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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* `CNY` - Chinese Yuan\n* `EUR` - Euro\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_detail"
],
"type": "object"
}
GET /api/part/test-template/¶
Description
Override the GET method to determine export options.
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": [
{
"choices": "string",
"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
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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"
}
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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"
}
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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"
}
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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"
}
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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"
}
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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"
}
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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
{
"choices": "string",
"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": {
"choices": {
"description": "Valid choices for this test (comma-separated)",
"maxLength": 5000,
"type": "string"
},
"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
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 |
Response 200 OK
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 |
Response 200 OK
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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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,
"category_detail": null,
"category_name": "string",
"category_path": [
{}
],
"component": true,
"copy_category_parameters": true,
"creation_date": "2022-04-13",
"creation_user": 0,
"default_expiry": 0,
"default_location": 0,
"default_location_detail": null,
"default_supplier": 0,
"description": "string",
"duplicate": null,
"existing_image": "string",
"external_stock": 10.12,
"full_name": "string",
"image": "string",
"in_stock": 10.12,
"initial_stock": null,
"initial_supplier": null,
"is_template": true,
"keywords": "string",
"last_stocktake": "2022-04-13",
"link": "string",
"locked": true,
"minimum_stock": 10.12,
"name": "string",
"notes": "string",
"ordering": 10.12,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"part": 0,
"part_detail": null,
"pk": 0,
"template": 0,
"template_detail": null
}
],
"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",
"revision_count": 0,
"revision_of": 0,
"salable": true,
"starred": true,
"stock_item_count": 0,
"suppliers": 0,
"tags": [
"string"
],
"testable": true,
"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": {
"default": "",
"maxLength": 100,
"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": {
"nullable": true,
"type": "integer"
},
"category_default_location": {
"nullable": true,
"readOnly": true,
"type": "integer"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true
},
"category_name": {
"readOnly": true,
"type": "string"
},
"category_path": {
"items": {
"additionalProperties": {},
"type": "object"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"component": {
"description": "Can this part be used to build other parts?",
"type": "boolean"
},
"copy_category_parameters": {
"default": true,
"description": "Copy parameter templates from selected part category",
"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_location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultLocation"
}
],
"nullable": true,
"readOnly": true
},
"default_supplier": {
"description": "Default supplier part",
"nullable": true,
"type": "integer"
},
"description": {
"description": "Part description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicatePart"
}
],
"description": "Copy initial data from another Part",
"title": "Duplicate Part",
"writeOnly": true
},
"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"
},
"initial_stock": {
"allOf": [
{
"$ref": "#/components/schemas/InitialStock"
}
],
"description": "Create Part with initial stock quantity",
"writeOnly": true
},
"initial_supplier": {
"allOf": [
{
"$ref": "#/components/schemas/InitialSupplier"
}
],
"description": "Add initial supplier information for this part",
"title": "Supplier Information",
"writeOnly": true
},
"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": 2000,
"nullable": true,
"type": "string"
},
"locked": {
"description": "Locked parts cannot be edited",
"type": "boolean"
},
"minimum_stock": {
"default": 0.0,
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/PartParameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"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": {
"default": "",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"revision_count": {
"readOnly": true,
"title": "Revisions",
"type": "integer"
},
"revision_of": {
"description": "Is this part a revision of another part?",
"nullable": true,
"type": "integer"
},
"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"
},
"testable": {
"description": "Can this part have test results recorded against it?",
"type": "boolean"
},
"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_name",
"external_stock",
"full_name",
"in_stock",
"name",
"ordering",
"pk",
"required_for_build_orders",
"required_for_sales_orders",
"revision_count",
"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
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 |
Response 200 OK
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 |
Response 200 OK
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": [
"scheduled_for_update"
],
"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": [
"scheduled_for_update"
],
"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": [
"scheduled_for_update"
],
"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": [
"scheduled_for_update"
],
"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": [
"scheduled_for_update"
],
"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": [
"scheduled_for_update"
],
"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
{
"date": "2022-04-13",
"label": "string",
"model": "string",
"model_id": 0,
"quantity": 10.12,
"speculative_quantity": 10.12,
"title": "string"
}
Schema of the response body
{
"description": "Serializer class for a PartScheduling entry.",
"properties": {
"date": {
"format": "date",
"nullable": true,
"type": "string"
},
"label": {
"type": "string"
},
"model": {
"type": "string"
},
"model_id": {
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"speculative_quantity": {
"format": "double",
"type": "number"
},
"title": {
"type": "string"
}
},
"required": [
"date",
"label",
"model",
"model_id",
"quantity",
"title"
],
"type": "object"
}
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| null |
level |
integer |
name |
string |
parent |
integer| null |
parent_default_location |
integer |
part_count |
integer |
path |
Array<> |
pathstring |
string |
pk |
integer |
starred |
boolean |
structural |
boolean |
subcategories |
integer |
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 |
DefaultLocation¶
| Name | Type |
|---|---|
name |
string |
pathstring |
string |
pk |
integer |
DuplicatePart¶
| Name | Type |
|---|---|
copy_bom |
boolean |
copy_image |
boolean |
copy_notes |
boolean |
copy_parameters |
boolean |
part |
integer |
InitialStock¶
| Name | Type |
|---|---|
location |
integer| null |
quantity |
string(decimal) |
InitialSupplier¶
| Name | Type |
|---|---|
manufacturer |
integer| null |
mpn |
string |
sku |
string |
supplier |
integer| null |
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> |
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| null |
category_default_location |
integer| null |
category_detail |
|
category_name |
string |
category_path |
Array<> |
component |
boolean |
copy_category_parameters |
boolean |
creation_date |
string(date)| null |
creation_user |
integer| null |
default_expiry |
integer |
default_location |
integer| null |
default_location_detail |
|
default_supplier |
integer| null |
description |
string |
duplicate |
|
existing_image |
string |
external_stock |
number(double) |
full_name |
string |
image |
string(uri)| null |
in_stock |
number(double) |
initial_stock |
|
initial_supplier |
|
IPN |
string |
is_template |
boolean |
keywords |
string| null |
last_stocktake |
string(date)| null |
link |
string(uri)| null |
locked |
boolean |
minimum_stock |
number(double) |
name |
string |
notes |
string| null |
ordering |
number(double) |
parameters |
Array<PartParameter> |
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 |
revision_count |
integer |
revision_of |
integer| null |
salable |
boolean |
starred |
boolean |
stock_item_count |
integer |
suppliers |
integer |
tags |
Array<string> |
testable |
boolean |
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 |
PartBrief¶
| Name | Type |
|---|---|
active |
boolean |
assembly |
boolean |
barcode_hash |
string |
category_default_location |
integer| null |
component |
boolean |
default_expiry |
integer |
default_location |
integer| null |
description |
string |
full_name |
string |
image |
string(uri) |
IPN |
string| null |
is_template |
boolean |
locked |
boolean |
name |
string |
pk |
integer |
pricing_max |
string(decimal)| null |
pricing_min |
string(decimal)| null |
purchaseable |
boolean |
revision |
string| null |
salable |
boolean |
testable |
boolean |
thumbnail |
string |
trackable |
boolean |
units |
string| null |
virtual |
boolean |
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 |
part_detail |
|
pk |
integer |
template |
integer |
template_detail |
PartParameterTemplate¶
| Name | Type |
|---|---|
checkbox |
boolean |
choices |
string |
description |
string |
name |
string |
parts |
integer |
pk |
integer |
selectionlist |
integer| null |
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 |
|---|---|
note |
string |
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) |
PartScheduling¶
| Name | Type |
|---|---|
date |
string(date)| null |
label |
string |
model |
string |
model_id |
integer |
quantity |
number(double) |
speculative_quantity |
number(double) |
title |
string |
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 |
|---|---|
choices |
string |
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| null |
level |
integer |
name |
string |
parent |
integer| null |
parent_default_location |
integer |
part_count |
integer |
path |
Array<> |
pathstring |
string |
pk |
integer |
starred |
boolean |
structural |
boolean |
subcategories |
integer |
PatchedCategoryParameterTemplate¶
| Name | Type |
|---|---|
category |
integer |
category_detail |
|
default_value |
string |
parameter_template |
integer |
parameter_template_detail |
|
pk |
integer |
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| null |
category_default_location |
integer| null |
category_detail |
|
category_name |
string |
category_path |
Array<> |
component |
boolean |
copy_category_parameters |
boolean |
creation_date |
string(date)| null |
creation_user |
integer| null |
default_expiry |
integer |
default_location |
integer| null |
default_location_detail |
|
default_supplier |
integer| null |
description |
string |
duplicate |
|
existing_image |
string |
external_stock |
number(double) |
full_name |
string |
image |
string(uri)| null |
in_stock |
number(double) |
initial_stock |
|
initial_supplier |
|
IPN |
string |
is_template |
boolean |
keywords |
string| null |
last_stocktake |
string(date)| null |
link |
string(uri)| null |
locked |
boolean |
minimum_stock |
number(double) |
name |
string |
notes |
string| null |
ordering |
number(double) |
parameters |
Array<PartParameter> |
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 |
revision_count |
integer |
revision_of |
integer| null |
salable |
boolean |
starred |
boolean |
stock_item_count |
integer |
suppliers |
integer |
tags |
Array<string> |
testable |
boolean |
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 |
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 |
part_detail |
|
pk |
integer |
template |
integer |
template_detail |
PatchedPartParameterTemplate¶
| Name | Type |
|---|---|
checkbox |
boolean |
choices |
string |
description |
string |
name |
string |
parts |
integer |
pk |
integer |
selectionlist |
integer| null |
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 |
|---|---|
note |
string |
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 |
PatchedPartStocktakeReport¶
| Name | Type |
|---|---|
date |
string(date) |
part_count |
integer |
pk |
integer |
report |
string(uri) |
user |
integer| null |
user_detail |
PatchedPartTestTemplate¶
| Name | Type |
|---|---|
choices |
string |
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 |
Common responses¶
This section describes common responses that are reused across operations.
allauth.AddAuthenticatorConflict¶
The account prohibits adding an authenticator, e.g. because of an unverified email address.
Schema of the response body
null
allauth.AddWebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.\n",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data",
"meta"
],
"type": "object"
}
allauth.Authenticated¶
The user is authenticated.
Schema of the response body
null
allauth.AuthenticatedByCode¶
Authenticated by code.
{
"summary": "Authenticated by code.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "code"
}
],
"user": {
"display": "wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPassword¶
Authenticated by password.
{
"summary": "Authenticated by password.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
}
],
"user": {
"display": "wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPasswordAnd2FA¶
Authenticated by password and 2FA.
{
"summary": "Fully authenticated using by password and 2FA.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.Authentication¶
Not authenticated.
{
"summary": "Reauthentication required\n",
"value": {
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
}
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending 2FA\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "mfa_authenticate",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending email verification\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "verify_email",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending provider signup\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "provider_signup",
"is_pending": true,
"provider": {
"client_id": "123.apps.googleusercontent.com",
"flows": [
"provider_redirect",
"provider_token"
],
"id": "google",
"name": "Google"
}
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.AuthenticationOrReauthentication¶
The response indicates authentication or re-authentication is required.
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/allauth.AuthenticationResponse"
},
{
"$ref": "#/components/schemas/allauth.ReauthenticationResponse"
}
]
}
allauth.Authenticators¶
List of authenticators.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.AuthenticatorList"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.Configuration¶
The django-allauth configuration.
Schema of the response body
null
allauth.EmailAddresses¶
List of email addresses.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.EmailVerificationInfo¶
Email verification information.
Schema of the response body
null
allauth.Error¶
An input error occurred.
Schema of the response body
null
allauth.Forbidden¶
A forbidden response.
Schema of the response body
null
allauth.NotFound¶
Not found.
{
"status": 0
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.PasswordResetInfo¶
Information about the password reset key.
{
"data": {
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ProviderAccounts¶
List of third-party provider accounts.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ReauthenticationRequired¶
The response indicates reauthentication is required.
{
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
Schema of the response body
allauth.RecoveryCodes¶
Information on the recovery codes.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.SensitiveRecoveryCodesAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.SessionGone¶
The response indicates session is invalid or no longer exists.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.Sessions¶
List of sessions.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.Session"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.StatusOK¶
A success response.
{
"status": null
}
Schema of the response body
{
"properties": {
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.TOTPAuthenticator¶
Information on the TOTP authenticator.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.TOTPAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.TOTPAuthenticatorNotFound¶
No TOTP authenticator has been set up.
{
"meta": {
"secret": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"totp_url": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example"
},
"status": 0
}
Schema of the response body
{
"properties": {
"meta": {
"properties": {
"secret": {
"description": "A TOTP secret that can be used to setup a new authenticator.\n",
"example": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"type": "string"
},
"totp_url": {
"description": "otpauth URI from which a QR code can be generated and scanned by OTP clients.\n",
"example": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example",
"type": "string"
}
},
"required": [
"secret",
"totp_url"
],
"type": "object"
},
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status",
"meta"
],
"type": "object"
}
allauth.Unauthenticated¶
There is no authenticated session.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.WebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnCreationOptionsResponse¶
WebAuthn credential creation options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialCreationOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnRequestOptionsResponse¶
WebAuthn credential request options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialRequestOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
Common parameters¶
This section describes common parameters that are reused across operations.
allauth.EmailVerificationKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Email-Verification-Key |
header | string | No |
allauth.PasswordResetKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Password-Reset-Key |
header | string | No |
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