Skip to content

The Parts and Part Categories section of the InvenTree API schema is documented below.

InvenTree API 198

API for InvenTree - the intuitive open source inventory management system


License: MIT

Servers

Description URL
http://localhost:8000 http://localhost:8000

part


GET /api/part/

Description

Generic handler for a download request.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
active query boolean No
ancestor query integer No
assembly query boolean No
component query boolean No
convert_from query integer No
created_after query string No Updated after
created_before query string No Updated before
default_location query integer No Default Location
depleted_stock query boolean No Depleted Stock
exclude_tree query integer No
has_ipn query boolean No Has IPN
has_pricing query boolean No Has Pricing
has_stock query boolean No Has stock
has_units query boolean No Has units
in_bom_for query integer No
IPN query string No Filter by exact IPN (internal part number)
IPN_regex query string No Filter by regex on IPN (internal part number)
is_template query boolean No
limit query integer No Number of results to return per page.
low_stock query boolean No Low stock
name_regex query string No Filter by name (regex)
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.
purchaseable query boolean No
salable query boolean No
search query string No A search term.
stock_to_build query boolean No Required for Build Order
stocktake query boolean No Has stocktake
tags_name query string No
tags_slug query string No
trackable query boolean No
unallocated_stock query boolean No Unallocated stock
variant_of query integer No Variant Of
virtual query boolean No

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "IPN": "string",
            "active": true,
            "allocated_to_build_orders": 10.12,
            "allocated_to_sales_orders": 10.12,
            "assembly": true,
            "barcode_hash": "string",
            "building": 10.12,
            "category": 0,
            "category_default_location": 0,
            "component": true,
            "creation_date": "2022-04-13",
            "creation_user": 0,
            "default_expiry": 0,
            "default_location": 0,
            "default_supplier": 0,
            "description": "string",
            "existing_image": "string",
            "external_stock": 10.12,
            "full_name": "string",
            "image": "string",
            "in_stock": 10.12,
            "is_template": true,
            "keywords": "string",
            "last_stocktake": "2022-04-13",
            "link": "string",
            "minimum_stock": 10.12,
            "name": "string",
            "notes": "string",
            "ordering": 10.12,
            "pk": 0,
            "purchaseable": true,
            "remote_image": "string",
            "required_for_build_orders": 0,
            "required_for_sales_orders": 0,
            "responsible": 0,
            "revision": "string",
            "salable": true,
            "starred": true,
            "stock_item_count": 0,
            "suppliers": 0,
            "tags": [
                "string"
            ],
            "thumbnail": "string",
            "total_in_stock": 10.12,
            "trackable": true,
            "unallocated_stock": 10.12,
            "units": "string",
            "variant_of": 0,
            "variant_stock": 10.12,
            "virtual": true
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "example": 123,
            "type": "integer"
        },
        "next": {
            "example": "http://api.example.org/accounts/?offset=400&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "previous": {
            "example": "http://api.example.org/accounts/?offset=200&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "results": {
            "items": {
                "$ref": "#/components/schemas/Part"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/part/

Description

API endpoint for accessing a list of Part objects, or creating a new Part instance.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "IPN": "string",
    "active": true,
    "allocated_to_build_orders": 10.12,
    "allocated_to_sales_orders": 10.12,
    "assembly": true,
    "barcode_hash": "string",
    "building": 10.12,
    "category": 0,
    "category_default_location": 0,
    "component": true,
    "creation_date": "2022-04-13",
    "creation_user": 0,
    "default_expiry": 0,
    "default_location": 0,
    "default_supplier": 0,
    "description": "string",
    "existing_image": "string",
    "external_stock": 10.12,
    "full_name": "string",
    "image": "string",
    "in_stock": 10.12,
    "is_template": true,
    "keywords": "string",
    "last_stocktake": "2022-04-13",
    "link": "string",
    "minimum_stock": 10.12,
    "name": "string",
    "notes": "string",
    "ordering": 10.12,
    "pk": 0,
    "purchaseable": true,
    "remote_image": "string",
    "required_for_build_orders": 0,
    "required_for_sales_orders": 0,
    "responsible": 0,
    "revision": "string",
    "salable": true,
    "starred": true,
    "stock_item_count": 0,
    "suppliers": 0,
    "tags": [
        "string"
    ],
    "thumbnail": "string",
    "total_in_stock": 10.12,
    "trackable": true,
    "unallocated_stock": 10.12,
    "units": "string",
    "variant_of": 0,
    "variant_stock": 10.12,
    "virtual": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
    "properties": {
        "IPN": {
            "description": "Internal Part Number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "active": {
            "description": "Is this part active?",
            "type": "boolean"
        },
        "allocated_to_build_orders": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "allocated_to_sales_orders": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "assembly": {
            "description": "Can this part be built from other parts?",
            "type": "boolean"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "readOnly": true,
            "type": "string"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "category": {
            "type": "integer"
        },
        "category_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "component": {
            "description": "Can this part be used to build other parts?",
            "type": "boolean"
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "creation_user": {
            "nullable": true,
            "type": "integer"
        },
        "default_expiry": {
            "description": "Expiry time (in days) for stock items of this part",
            "minimum": 0,
            "type": "integer"
        },
        "default_location": {
            "description": "Where is this item normally stored?",
            "nullable": true,
            "type": "integer"
        },
        "default_supplier": {
            "description": "Default supplier part",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Part description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "existing_image": {
            "description": "Filename of an existing part image",
            "type": "string",
            "writeOnly": true
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "full_name": {
            "description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
            "readOnly": true,
            "type": "string"
        },
        "image": {
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "in_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "is_template": {
            "description": "Is this part a template part?",
            "type": "boolean"
        },
        "keywords": {
            "description": "Part keywords to improve visibility in search results",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "last_stocktake": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "minimum_stock": {
            "format": "double",
            "type": "number"
        },
        "name": {
            "description": "Part name",
            "maxLength": 100,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "ordering": {
            "format": "double",
            "readOnly": true,
            "title": "On Order",
            "type": "number"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchaseable": {
            "description": "Can this part be purchased from external suppliers?",
            "type": "boolean"
        },
        "remote_image": {
            "description": "URL of remote image file",
            "format": "uri",
            "type": "string",
            "writeOnly": true
        },
        "required_for_build_orders": {
            "readOnly": true,
            "type": "integer"
        },
        "required_for_sales_orders": {
            "readOnly": true,
            "type": "integer"
        },
        "responsible": {
            "nullable": true,
            "type": "integer"
        },
        "revision": {
            "description": "Part revision or version number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "salable": {
            "description": "Can this part be sold to customers?",
            "type": "boolean"
        },
        "starred": {
            "description": "Return \"true\" if the part is starred by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "stock_item_count": {
            "readOnly": true,
            "title": "Stock Items",
            "type": "integer"
        },
        "suppliers": {
            "readOnly": true,
            "type": "integer"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "thumbnail": {
            "readOnly": true,
            "type": "string"
        },
        "total_in_stock": {
            "format": "double",
            "readOnly": true,
            "title": "Total Stock",
            "type": "number"
        },
        "trackable": {
            "description": "Does this part have tracking for unique items?",
            "type": "boolean"
        },
        "unallocated_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "units": {
            "description": "Units of measure for this part",
            "maxLength": 20,
            "nullable": true,
            "type": "string"
        },
        "variant_of": {
            "description": "Is this part a variant of another part?",
            "nullable": true,
            "type": "integer"
        },
        "variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "virtual": {
            "description": "Is this a virtual part, such as a software product or license?",
            "type": "boolean"
        }
    },
    "required": [
        "allocated_to_build_orders",
        "allocated_to_sales_orders",
        "barcode_hash",
        "building",
        "category",
        "category_default_location",
        "creation_date",
        "external_stock",
        "full_name",
        "in_stock",
        "minimum_stock",
        "name",
        "ordering",
        "pk",
        "required_for_build_orders",
        "required_for_sales_orders",
        "starred",
        "stock_item_count",
        "suppliers",
        "thumbnail",
        "total_in_stock",
        "unallocated_stock",
        "variant_stock"
    ],
    "type": "object"
}

{
    "IPN": "string",
    "active": true,
    "allocated_to_build_orders": 10.12,
    "allocated_to_sales_orders": 10.12,
    "assembly": true,
    "barcode_hash": "string",
    "building": 10.12,
    "category": 0,
    "category_default_location": 0,
    "component": true,
    "creation_date": "2022-04-13",
    "creation_user": 0,
    "default_expiry": 0,
    "default_location": 0,
    "default_supplier": 0,
    "description": "string",
    "existing_image": "string",
    "external_stock": 10.12,
    "full_name": "string",
    "image": "string",
    "in_stock": 10.12,
    "is_template": true,
    "keywords": "string",
    "last_stocktake": "2022-04-13",
    "link": "string",
    "minimum_stock": 10.12,
    "name": "string",
    "notes": "string",
    "ordering": 10.12,
    "pk": 0,
    "purchaseable": true,
    "remote_image": "string",
    "required_for_build_orders": 0,
    "required_for_sales_orders": 0,
    "responsible": 0,
    "revision": "string",
    "salable": true,
    "starred": true,
    "stock_item_count": 0,
    "suppliers": 0,
    "tags": [
        "string"
    ],
    "thumbnail": "string",
    "total_in_stock": 10.12,
    "trackable": true,
    "unallocated_stock": 10.12,
    "units": "string",
    "variant_of": 0,
    "variant_stock": 10.12,
    "virtual": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
    "properties": {
        "IPN": {
            "description": "Internal Part Number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "active": {
            "description": "Is this part active?",
            "type": "boolean"
        },
        "allocated_to_build_orders": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "allocated_to_sales_orders": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "assembly": {
            "description": "Can this part be built from other parts?",
            "type": "boolean"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "readOnly": true,
            "type": "string"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "category": {
            "type": "integer"
        },
        "category_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "component": {
            "description": "Can this part be used to build other parts?",
            "type": "boolean"
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "creation_user": {
            "nullable": true,
            "type": "integer"
        },
        "default_expiry": {
            "description": "Expiry time (in days) for stock items of this part",
            "minimum": 0,
            "type": "integer"
        },
        "default_location": {
            "description": "Where is this item normally stored?",
            "nullable": true,
            "type": "integer"
        },
        "default_supplier": {
            "description": "Default supplier part",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Part description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "existing_image": {
            "description": "Filename of an existing part image",
            "type": "string",
            "writeOnly": true
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "full_name": {
            "description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
            "readOnly": true,
            "type": "string"
        },
        "image": {
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "in_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "is_template": {
            "description": "Is this part a template part?",
            "type": "boolean"
        },
        "keywords": {
            "description": "Part keywords to improve visibility in search results",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "last_stocktake": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "minimum_stock": {
            "format": "double",
            "type": "number"
        },
        "name": {
            "description": "Part name",
            "maxLength": 100,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "ordering": {
            "format": "double",
            "readOnly": true,
            "title": "On Order",
            "type": "number"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchaseable": {
            "description": "Can this part be purchased from external suppliers?",
            "type": "boolean"
        },
        "remote_image": {
            "description": "URL of remote image file",
            "format": "uri",
            "type": "string",
            "writeOnly": true
        },
        "required_for_build_orders": {
            "readOnly": true,
            "type": "integer"
        },
        "required_for_sales_orders": {
            "readOnly": true,
            "type": "integer"
        },
        "responsible": {
            "nullable": true,
            "type": "integer"
        },
        "revision": {
            "description": "Part revision or version number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "salable": {
            "description": "Can this part be sold to customers?",
            "type": "boolean"
        },
        "starred": {
            "description": "Return \"true\" if the part is starred by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "stock_item_count": {
            "readOnly": true,
            "title": "Stock Items",
            "type": "integer"
        },
        "suppliers": {
            "readOnly": true,
            "type": "integer"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "thumbnail": {
            "readOnly": true,
            "type": "string"
        },
        "total_in_stock": {
            "format": "double",
            "readOnly": true,
            "title": "Total Stock",
            "type": "number"
        },
        "trackable": {
            "description": "Does this part have tracking for unique items?",
            "type": "boolean"
        },
        "unallocated_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "units": {
            "description": "Units of measure for this part",
            "maxLength": 20,
            "nullable": true,
            "type": "string"
        },
        "variant_of": {
            "description": "Is this part a variant of another part?",
            "nullable": true,
            "type": "integer"
        },
        "variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "virtual": {
            "description": "Is this a virtual part, such as a software product or license?",
            "type": "boolean"
        }
    },
    "required": [
        "allocated_to_build_orders",
        "allocated_to_sales_orders",
        "barcode_hash",
        "building",
        "category",
        "category_default_location",
        "creation_date",
        "external_stock",
        "full_name",
        "in_stock",
        "minimum_stock",
        "name",
        "ordering",
        "pk",
        "required_for_build_orders",
        "required_for_sales_orders",
        "starred",
        "stock_item_count",
        "suppliers",
        "thumbnail",
        "total_in_stock",
        "unallocated_stock",
        "variant_stock"
    ],
    "type": "object"
}

{
    "IPN": "string",
    "active": true,
    "allocated_to_build_orders": 10.12,
    "allocated_to_sales_orders": 10.12,
    "assembly": true,
    "barcode_hash": "string",
    "building": 10.12,
    "category": 0,
    "category_default_location": 0,
    "component": true,
    "creation_date": "2022-04-13",
    "creation_user": 0,
    "default_expiry": 0,
    "default_location": 0,
    "default_supplier": 0,
    "description": "string",
    "existing_image": "string",
    "external_stock": 10.12,
    "full_name": "string",
    "image": "string",
    "in_stock": 10.12,
    "is_template": true,
    "keywords": "string",
    "last_stocktake": "2022-04-13",
    "link": "string",
    "minimum_stock": 10.12,
    "name": "string",
    "notes": "string",
    "ordering": 10.12,
    "pk": 0,
    "purchaseable": true,
    "remote_image": "string",
    "required_for_build_orders": 0,
    "required_for_sales_orders": 0,
    "responsible": 0,
    "revision": "string",
    "salable": true,
    "starred": true,
    "stock_item_count": 0,
    "suppliers": 0,
    "tags": [
        "string"
    ],
    "thumbnail": "string",
    "total_in_stock": 10.12,
    "trackable": true,
    "unallocated_stock": 10.12,
    "units": "string",
    "variant_of": 0,
    "variant_stock": 10.12,
    "virtual": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
    "properties": {
        "IPN": {
            "description": "Internal Part Number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "active": {
            "description": "Is this part active?",
            "type": "boolean"
        },
        "allocated_to_build_orders": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "allocated_to_sales_orders": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "assembly": {
            "description": "Can this part be built from other parts?",
            "type": "boolean"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "readOnly": true,
            "type": "string"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "category": {
            "type": "integer"
        },
        "category_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "component": {
            "description": "Can this part be used to build other parts?",
            "type": "boolean"
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "creation_user": {
            "nullable": true,
            "type": "integer"
        },
        "default_expiry": {
            "description": "Expiry time (in days) for stock items of this part",
            "minimum": 0,
            "type": "integer"
        },
        "default_location": {
            "description": "Where is this item normally stored?",
            "nullable": true,
            "type": "integer"
        },
        "default_supplier": {
            "description": "Default supplier part",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Part description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "existing_image": {
            "description": "Filename of an existing part image",
            "type": "string",
            "writeOnly": true
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "full_name": {
            "description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
            "readOnly": true,
            "type": "string"
        },
        "image": {
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "in_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "is_template": {
            "description": "Is this part a template part?",
            "type": "boolean"
        },
        "keywords": {
            "description": "Part keywords to improve visibility in search results",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "last_stocktake": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "minimum_stock": {
            "format": "double",
            "type": "number"
        },
        "name": {
            "description": "Part name",
            "maxLength": 100,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "ordering": {
            "format": "double",
            "readOnly": true,
            "title": "On Order",
            "type": "number"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchaseable": {
            "description": "Can this part be purchased from external suppliers?",
            "type": "boolean"
        },
        "remote_image": {
            "description": "URL of remote image file",
            "format": "uri",
            "type": "string",
            "writeOnly": true
        },
        "required_for_build_orders": {
            "readOnly": true,
            "type": "integer"
        },
        "required_for_sales_orders": {
            "readOnly": true,
            "type": "integer"
        },
        "responsible": {
            "nullable": true,
            "type": "integer"
        },
        "revision": {
            "description": "Part revision or version number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "salable": {
            "description": "Can this part be sold to customers?",
            "type": "boolean"
        },
        "starred": {
            "description": "Return \"true\" if the part is starred by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "stock_item_count": {
            "readOnly": true,
            "title": "Stock Items",
            "type": "integer"
        },
        "suppliers": {
            "readOnly": true,
            "type": "integer"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "thumbnail": {
            "readOnly": true,
            "type": "string"
        },
        "total_in_stock": {
            "format": "double",
            "readOnly": true,
            "title": "Total Stock",
            "type": "number"
        },
        "trackable": {
            "description": "Does this part have tracking for unique items?",
            "type": "boolean"
        },
        "unallocated_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "units": {
            "description": "Units of measure for this part",
            "maxLength": 20,
            "nullable": true,
            "type": "string"
        },
        "variant_of": {
            "description": "Is this part a variant of another part?",
            "nullable": true,
            "type": "integer"
        },
        "variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "virtual": {
            "description": "Is this a virtual part, such as a software product or license?",
            "type": "boolean"
        }
    },
    "required": [
        "allocated_to_build_orders",
        "allocated_to_sales_orders",
        "barcode_hash",
        "building",
        "category",
        "category_default_location",
        "creation_date",
        "external_stock",
        "full_name",
        "in_stock",
        "minimum_stock",
        "name",
        "ordering",
        "pk",
        "required_for_build_orders",
        "required_for_sales_orders",
        "starred",
        "stock_item_count",
        "suppliers",
        "thumbnail",
        "total_in_stock",
        "unallocated_stock",
        "variant_stock"
    ],
    "type": "object"
}

Response 201 Created

{
    "IPN": "string",
    "active": true,
    "allocated_to_build_orders": 10.12,
    "allocated_to_sales_orders": 10.12,
    "assembly": true,
    "barcode_hash": "string",
    "building": 10.12,
    "category": 0,
    "category_default_location": 0,
    "component": true,
    "creation_date": "2022-04-13",
    "creation_user": 0,
    "default_expiry": 0,
    "default_location": 0,
    "default_supplier": 0,
    "description": "string",
    "existing_image": "string",
    "external_stock": 10.12,
    "full_name": "string",
    "image": "string",
    "in_stock": 10.12,
    "is_template": true,
    "keywords": "string",
    "last_stocktake": "2022-04-13",
    "link": "string",
    "minimum_stock": 10.12,
    "name": "string",
    "notes": "string",
    "ordering": 10.12,
    "pk": 0,
    "purchaseable": true,
    "remote_image": "string",
    "required_for_build_orders": 0,
    "required_for_sales_orders": 0,
    "responsible": 0,
    "revision": "string",
    "salable": true,
    "starred": true,
    "stock_item_count": 0,
    "suppliers": 0,
    "tags": [
        "string"
    ],
    "thumbnail": "string",
    "total_in_stock": 10.12,
    "trackable": true,
    "unallocated_stock": 10.12,
    "units": "string",
    "variant_of": 0,
    "variant_stock": 10.12,
    "virtual": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for complete detail information of a part.\n\nUsed when displaying all details of a single component.",
    "properties": {
        "IPN": {
            "description": "Internal Part Number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "active": {
            "description": "Is this part active?",
            "type": "boolean"
        },
        "allocated_to_build_orders": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "allocated_to_sales_orders": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "assembly": {
            "description": "Can this part be built from other parts?",
            "type": "boolean"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "readOnly": true,
            "type": "string"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "category": {
            "type": "integer"
        },
        "category_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "component": {
            "description": "Can this part be used to build other parts?",
            "type": "boolean"
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "creation_user": {
            "nullable": true,
            "type": "integer"
        },
        "default_expiry": {
            "description": "Expiry time (in days) for stock items of this part",
            "minimum": 0,
            "type": "integer"
        },
        "default_location": {
            "description": "Where is this item normally stored?",
            "nullable": true,
            "type": "integer"
        },
        "default_supplier": {
            "description": "Default supplier part",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Part description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "existing_image": {
            "description": "Filename of an existing part image",
            "type": "string",
            "writeOnly": true
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "full_name": {
            "description": "Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.",
            "readOnly": true,
            "type": "string"
        },
        "image": {
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "in_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "is_template": {
            "description": "Is this part a template part?",
            "type": "boolean"
        },
        "keywords": {
            "description": "Part keywords to improve visibility in search results",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "last_stocktake": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "minimum_stock": {
            "format": "double",
            "type": "number"
        },
        "name": {
            "description": "Part name",
            "maxLength": 100,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "ordering": {
            "format": "double",
            "readOnly": true,
            "title": "On Order",
            "type": "number"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchaseable": {
            "description": "Can this part be purchased from external suppliers?",
            "type": "boolean"
        },
        "remote_image": {
            "description": "URL of remote image file",
            "format": "uri",
            "type": "string",
            "writeOnly": true
        },
        "required_for_build_orders": {
            "readOnly": true,
            "type": "integer"
        },
        "required_for_sales_orders": {
            "readOnly": true,
            "type": "integer"
        },
        "responsible": {
            "nullable": true,
            "type": "integer"
        },
        "revision": {
            "description": "Part revision or version number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "salable": {
            "description": "Can this part be sold to customers?",
            "type": "boolean"
        },
        "starred": {
            "description": "Return \"true\" if the part is starred by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "stock_item_count": {
            "readOnly": true,
            "title": "Stock Items",
            "type": "integer"
        },
        "suppliers": {
            "readOnly": true,
            "type": "integer"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "thumbnail": {
            "readOnly": true,
            "type": "string"
        },
        "total_in_stock": {
            "format": "double",
            "readOnly": true,
            "title": "Total Stock",
            "type": "number"
        },
        "trackable": {
            "description": "Does this part have tracking for unique items?",
            "type": "boolean"
        },
        "unallocated_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "units": {
            "description": "Units of measure for this part",
            "maxLength": 20,
            "nullable": true,
            "type": "string"
        },
        "variant_of": {
            "description": "Is this part a variant of another part?",
            "nullable": true,
            "type": "integer"
        },
        "variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "virtual": {
            "description": "Is this a virtual part, such as a software product or license?",
            "type": "boolean"
        }
    },
    "required": [
        "allocated_to_build_orders",
        "allocated_to_sales_orders",
        "barcode_hash",
        "building",
        "category",
        "category_default_location",
        "creation_date",
        "external_stock",
        "full_name",
        "in_stock",
        "minimum_stock",
        "name",
        "ordering",
        "pk",
        "required_for_build_orders",
        "required_for_sales_orders",
        "starred",
        "stock_item_count",
        "suppliers",
        "thumbnail",
        "total_in_stock",
        "unallocated_stock",
        "variant_stock"
    ],
    "type": "object"
}

DELETE /api/part/attachment/

Description

Perform a DELETE operation against this list endpoint.

We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Response 204 No Content


GET /api/part/attachment/

Description

API endpoint for listing, creating and bulk deleting a PartAttachment (file upload).

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.
part query integer No
search query string No A search term.

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "attachment": "string",
            "comment": "string",
            "filename": "string",
            "link": "string",
            "part": 0,
            "pk": 0,
            "upload_date": "2022-04-13",
            "user": 0,
            "user_detail": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "example": 123,
            "type": "integer"
        },
        "next": {
            "example": "http://api.example.org/accounts/?offset=400&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "previous": {
            "example": "http://api.example.org/accounts/?offset=200&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "results": {
            "items": {
                "$ref": "#/components/schemas/PartAttachment"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/part/attachment/

Description

API endpoint for listing, creating and bulk deleting a PartAttachment (file upload).

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

Response 201 Created

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

DELETE /api/part/attachment/{id}/

Description

Detail endpoint for PartAttachment model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 204 No Content


GET /api/part/attachment/{id}/

Description

Detail endpoint for PartAttachment model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

PATCH /api/part/attachment/{id}/

Description

Detail endpoint for PartAttachment model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "type": "object"
}

Response 200 OK

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

PUT /api/part/attachment/{id}/

Description

Detail endpoint for PartAttachment model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

Response 200 OK

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "part": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the PartAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

GET /api/part/category/

Description

Generic handler for a download request.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
cascade query boolean No Include sub-categories in filtered results
depth query number No Filter by category depth
exclude_tree query integer No
limit query integer No Number of results to return per page.
name query string No
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.
parent query integer No Filter by parent category
search query string No A search term.
starred query boolean No Filter by starred categories
structural query boolean No

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "default_keywords": "string",
            "default_location": 0,
            "description": "string",
            "icon": "string",
            "level": 0,
            "name": "string",
            "parent": 0,
            "parent_default_location": 0,
            "part_count": 0,
            "pathstring": "string",
            "pk": 0,
            "starred": true,
            "structural": true,
            "subcategories": 0,
            "url": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "example": 123,
            "type": "integer"
        },
        "next": {
            "example": "http://api.example.org/accounts/?offset=400&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "previous": {
            "example": "http://api.example.org/accounts/?offset=200&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "results": {
            "items": {
                "$ref": "#/components/schemas/Category"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/part/category/

Description

API endpoint for accessing a list of PartCategory objects.

  • GET: Return a list of PartCategory objects
  • POST: Create a new PartCategory object

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "level",
        "name",
        "parent_default_location",
        "part_count",
        "pk",
        "starred",
        "subcategories",
        "url"
    ],
    "type": "object"
}

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "level",
        "name",
        "parent_default_location",
        "part_count",
        "pk",
        "starred",
        "subcategories",
        "url"
    ],
    "type": "object"
}

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "level",
        "name",
        "parent_default_location",
        "part_count",
        "pk",
        "starred",
        "subcategories",
        "url"
    ],
    "type": "object"
}

Response 201 Created

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "level",
        "name",
        "parent_default_location",
        "part_count",
        "pk",
        "starred",
        "subcategories",
        "url"
    ],
    "type": "object"
}

GET /api/part/category/parameters/

Description

API endpoint for accessing a list of PartCategoryParameterTemplate objects.

  • GET: Return a list of PartCategoryParameterTemplate objects

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "category": 0,
            "category_detail": null,
            "default_value": "string",
            "parameter_template": 0,
            "parameter_template_detail": null,
            "pk": 0
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "category",
        "category_detail",
        "parameter_template",
        "parameter_template_detail",
        "pk"
    ],
    "type": "object"
}

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "category",
        "category_detail",
        "parameter_template",
        "parameter_template_detail",
        "pk"
    ],
    "type": "object"
}

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "category",
        "category_detail",
        "parameter_template",
        "parameter_template_detail",
        "pk"
    ],
    "type": "object"
}

Response 201 Created

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "category",
        "category_detail",
        "parameter_template",
        "parameter_template_detail",
        "pk"
    ],
    "type": "object"
}

DELETE /api/part/category/parameters/{id}/

Description

Detail endpoint for the PartCategoryParameterTemplate model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 204 No Content


GET /api/part/category/parameters/{id}/

Description

Detail endpoint for the PartCategoryParameterTemplate model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "category",
        "category_detail",
        "parameter_template",
        "parameter_template_detail",
        "pk"
    ],
    "type": "object"
}

PATCH /api/part/category/parameters/{id}/

Description

Detail endpoint for the PartCategoryParameterTemplate model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "type": "object"
}

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "type": "object"
}

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "category",
        "category_detail",
        "parameter_template",
        "parameter_template_detail",
        "pk"
    ],
    "type": "object"
}

PUT /api/part/category/parameters/{id}/

Description

Detail endpoint for the PartCategoryParameterTemplate model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "category",
        "category_detail",
        "parameter_template",
        "parameter_template_detail",
        "pk"
    ],
    "type": "object"
}

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "category",
        "category_detail",
        "parameter_template",
        "parameter_template_detail",
        "pk"
    ],
    "type": "object"
}

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "category",
        "category_detail",
        "parameter_template",
        "parameter_template_detail",
        "pk"
    ],
    "type": "object"
}

Response 200 OK

{
    "category": 0,
    "category_detail": null,
    "default_value": "string",
    "parameter_template": 0,
    "parameter_template_detail": null,
    "pk": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the PartCategoryParameterTemplate model.",
    "properties": {
        "category": {
            "description": "Part Category",
            "type": "integer"
        },
        "category_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Category"
                }
            ],
            "readOnly": true
        },
        "default_value": {
            "description": "Default Parameter Value",
            "maxLength": 500,
            "type": "string"
        },
        "parameter_template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "parameter_template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        }
    },
    "required": [
        "category",
        "category_detail",
        "parameter_template",
        "parameter_template_detail",
        "pk"
    ],
    "type": "object"
}

GET /api/part/category/parameters/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

PATCH /api/part/category/parameters/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

Response 200 OK

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

PUT /api/part/category/parameters/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

Response 200 OK

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

GET /api/part/category/tree/

Description

API endpoint for accessing a list of PartCategory objects ready for rendering a tree.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "icon": "string",
            "name": "string",
            "parent": 0,
            "pk": 0,
            "structural": true,
            "subcategories": 0
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "example": 123,
            "type": "integer"
        },
        "next": {
            "example": "http://api.example.org/accounts/?offset=400&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "previous": {
            "example": "http://api.example.org/accounts/?offset=200&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "results": {
            "items": {
                "$ref": "#/components/schemas/CategoryTree"
            },
            "type": "array"
        }
    },
    "type": "object"
}

DELETE /api/part/category/{id}/

Description

Custom delete method to pass kwargs.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 204 No Content


GET /api/part/category/{id}/

Description

Custom get method to pass kwargs.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "level",
        "name",
        "parent_default_location",
        "part_count",
        "pk",
        "starred",
        "subcategories",
        "url"
    ],
    "type": "object"
}

PATCH /api/part/category/{id}/

Description

Custom patch method to pass kwargs.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "level",
        "name",
        "parent_default_location",
        "part_count",
        "pk",
        "starred",
        "subcategories",
        "url"
    ],
    "type": "object"
}

PUT /api/part/category/{id}/

Description

Custom put method to pass kwargs.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "level",
        "name",
        "parent_default_location",
        "part_count",
        "pk",
        "starred",
        "subcategories",
        "url"
    ],
    "type": "object"
}

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "level",
        "name",
        "parent_default_location",
        "part_count",
        "pk",
        "starred",
        "subcategories",
        "url"
    ],
    "type": "object"
}

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "level",
        "name",
        "parent_default_location",
        "part_count",
        "pk",
        "starred",
        "subcategories",
        "url"
    ],
    "type": "object"
}

Response 200 OK

{
    "default_keywords": "string",
    "default_location": 0,
    "description": "string",
    "icon": "string",
    "level": 0,
    "name": "string",
    "parent": 0,
    "parent_default_location": 0,
    "part_count": 0,
    "pathstring": "string",
    "pk": 0,
    "starred": true,
    "structural": true,
    "subcategories": 0,
    "url": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for PartCategory.",
    "properties": {
        "default_keywords": {
            "description": "Default keywords for parts in this category",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "default_location": {
            "description": "Default location for parts in this category",
            "nullable": true,
            "type": "integer"
        },
        "description": {
            "description": "Description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "icon": {
            "description": "Icon (optional)",
            "maxLength": 100,
            "type": "string"
        },
        "level": {
            "readOnly": true,
            "type": "integer"
        },
        "name": {
            "description": "Name",
            "maxLength": 100,
            "type": "string"
        },
        "parent": {
            "nullable": true,
            "type": "integer"
        },
        "parent_default_location": {
            "readOnly": true,
            "type": "integer"
        },
        "part_count": {
            "readOnly": true,
            "title": "Parts",
            "type": "integer"
        },
        "pathstring": {
            "description": "Path",
            "maxLength": 250,
            "title": "Path",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "starred": {
            "description": "Return True if the category is directly \"starred\" by the current user.",
            "readOnly": true,
            "type": "boolean"
        },
        "structural": {
            "description": "Parts may not be directly assigned to a structural category, but may be assigned to child categories.",
            "type": "boolean"
        },
        "subcategories": {
            "readOnly": true,
            "type": "integer"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "level",
        "name",
        "parent_default_location",
        "part_count",
        "pk",
        "starred",
        "subcategories",
        "url"
    ],
    "type": "object"
}

GET /api/part/category/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

PATCH /api/part/category/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

Response 200 OK

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

PUT /api/part/category/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

Response 200 OK

{
    "metadata": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

POST /api/part/change_category/

Description

API endpoint to change the location of multiple parts in bulk.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "category": 0,
    "parts": [
        0
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for changing PartCategory for multiple Part objects.",
    "properties": {
        "category": {
            "description": "Select category",
            "type": "integer"
        },
        "parts": {
            "items": {
                "title": "Parts",
                "type": "integer"
            },
            "type": "array"
        }
    },
    "required": [
        "category",
        "parts"
    ],
    "type": "object"
}

{
    "category": 0,
    "parts": [
        0
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for changing PartCategory for multiple Part objects.",
    "properties": {
        "category": {
            "description": "Select category",
            "type": "integer"
        },
        "parts": {
            "items": {
                "title": "Parts",
                "type": "integer"
            },
            "type": "array"
        }
    },
    "required": [
        "category",
        "parts"
    ],
    "type": "object"
}

{
    "category": 0,
    "parts": [
        0
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for changing PartCategory for multiple Part objects.",
    "properties": {
        "category": {
            "description": "Select category",
            "type": "integer"
        },
        "parts": {
            "items": {
                "title": "Parts",
                "type": "integer"
            },
            "type": "array"
        }
    },
    "required": [
        "category",
        "parts"
    ],
    "type": "object"
}

Response 201 Created

{
    "category": 0,
    "parts": [
        0
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for changing PartCategory for multiple Part objects.",
    "properties": {
        "category": {
            "description": "Select category",
            "type": "integer"
        },
        "parts": {
            "items": {
                "title": "Parts",
                "type": "integer"
            },
            "type": "array"
        }
    },
    "required": [
        "category",
        "parts"
    ],
    "type": "object"
}

GET /api/part/internal-price/

Description

API endpoint for list view of PartInternalPriceBreak model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.
part query integer No
search query string No A search term.

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "part": 0,
            "pk": 0,
            "price": "string",
            "price_currency": null,
            "quantity": 10.12
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "required": [
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "required": [
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "required": [
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Response 201 Created

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "required": [
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

DELETE /api/part/internal-price/{id}/

Description

Detail endpoint for PartInternalPriceBreak model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 204 No Content


GET /api/part/internal-price/{id}/

Description

Detail endpoint for PartInternalPriceBreak model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "required": [
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

PATCH /api/part/internal-price/{id}/

Description

Detail endpoint for PartInternalPriceBreak model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "type": "object"
}

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "type": "object"
}

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "required": [
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

PUT /api/part/internal-price/{id}/

Description

Detail endpoint for PartInternalPriceBreak model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "required": [
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "required": [
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "required": [
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Response 200 OK

{
    "part": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for internal prices for Part model.",
    "properties": {
        "part": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase currency of this stock item\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        }
    },
    "required": [
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

GET /api/part/parameter/

Description

API endpoint for accessing a list of PartParameter objects.

  • GET: Return list of PartParameter objects
  • POST: Create a new PartParameter object

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.
part query integer No
search query string No A search term.
template query integer No

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "part": 0,
            "pk": 0,
            "template": 0,
            "template_detail": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "example": 123,
            "type": "integer"
        },
        "next": {
            "example": "http://api.example.org/accounts/?offset=400&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "previous": {
            "example": "http://api.example.org/accounts/?offset=200&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "results": {
            "items": {
                "$ref": "#/components/schemas/PartParameter"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/part/parameter/

Description

API endpoint for accessing a list of PartParameter objects.

  • GET: Return list of PartParameter objects
  • POST: Create a new PartParameter object

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "data": "string",
    "data_numeric": 10.12,
    "part": 0,
    "pk": 0,
    "template": 0,
    "template_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "JSON serializers for the PartParameter model.",
    "properties": {
        "data": {
            "description": "Parameter Value",
            "maxLength": 500,
            "minLength": 1,
            "type": "string"
        },
        "data_numeric": {
            "format": "double",
            "nullable": true,
            "type": "number"
        },
        "part": {
            "description": "Parent Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "data",
        "part",
        "pk",
        "template",
        "template_detail"
    ],
    "type": "object"
}

{
    "data": "string",
    "data_numeric": 10.12,
    "part": 0,
    "pk": 0,
    "template": 0,
    "template_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "JSON serializers for the PartParameter model.",
    "properties": {
        "data": {
            "description": "Parameter Value",
            "maxLength": 500,
            "minLength": 1,
            "type": "string"
        },
        "data_numeric": {
            "format": "double",
            "nullable": true,
            "type": "number"
        },
        "part": {
            "description": "Parent Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "data",
        "part",
        "pk",
        "template",
        "template_detail"
    ],
    "type": "object"
}

{
    "data": "string",
    "data_numeric": 10.12,
    "part": 0,
    "pk": 0,
    "template": 0,
    "template_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "JSON serializers for the PartParameter model.",
    "properties": {
        "data": {
            "description": "Parameter Value",
            "maxLength": 500,
            "minLength": 1,
            "type": "string"
        },
        "data_numeric": {
            "format": "double",
            "nullable": true,
            "type": "number"
        },
        "part": {
            "description": "Parent Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "data",
        "part",
        "pk",
        "template",
        "template_detail"
    ],
    "type": "object"
}

Response 201 Created

{
    "data": "string",
    "data_numeric": 10.12,
    "part": 0,
    "pk": 0,
    "template": 0,
    "template_detail": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "JSON serializers for the PartParameter model.",
    "properties": {
        "data": {
            "description": "Parameter Value",
            "maxLength": 500,
            "minLength": 1,
            "type": "string"
        },
        "data_numeric": {
            "format": "double",
            "nullable": true,
            "type": "number"
        },
        "part": {
            "description": "Parent Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "template": {
            "description": "Parameter Template",
            "type": "integer"
        },
        "template_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartParameterTemplate"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "data",
        "part",
        "pk",
        "template",
        "template_detail"
    ],
    "type": "object"
}

GET /api/part/parameter/template/

Description

API endpoint for accessing a list of PartParameterTemplate objects.

  • GET: Return list of PartParameterTemplate objects
  • POST: Create a new PartParameterTemplate object

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
category query integer No
checkbox query boolean No
has_choices query boolean No Has Choice
has_units query boolean No Has Units
limit query integer No Number of results to return per page.
name query string No
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.
part query integer No
search query string No A search term.
units query string No

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "checkbox": true,
            "choices": "string",
            "description": "string",
            "name": "string",
            "parts": 0,
            "pk": 0,
            "units": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "example": 123,
            "type": "integer"
        },
        "next": {
            "example": "http://api.example.org/accounts/?offset=400&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "previous": {
            "example": "http://api.example.org/accounts/?offset=200&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "results": {
            "items": {
                "$ref": "#/components/schemas/PartParameterTemplate"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/part/parameter/template/

Description

API endpoint for accessing a list of PartParameterTemplate objects.

  • GET: Return list of PartParameterTemplate objects
  • POST: Create a new PartParameterTemplate object

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "checkbox": true,
    "choices": "string",
    "description": "string",
    "name": "string",
    "parts": 0,
    "pk": 0,
    "units": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "JSON serializer for the PartParameterTemplate model.",
    "properties": {
        "checkbox": {
            "description": "Is this parameter a checkbox?",
            "type": "boolean"
        },
        "choices": {
            "description": "Valid choices for this parameter (comma-separated)",
            "maxLength": 5000,
            "type": "string"
        },
        "description": {
            "description": "Parameter description",
            "maxLength": 250,
            "type": "string"
        },
        "name": {
            "description": "Parameter Name",
            "maxLength": 100,
            "type": "string"
        },
        "parts": {
            "description": "Number of parts using this template",
            "readOnly": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "units": {
            "description": "Physical units for this parameter",
            "maxLength": 25,
            "type": "string"
        }
    },
    "required": [
        "name",
        "parts",
        "pk"
    ],
    "type": "object"
}

{
    "checkbox": true,
    "choices": "string",
    "description": "string",
    "name": "string",
    "parts": 0,
    "pk":