Skip to content

The Build Order Management 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

build


GET /api/build/

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 Build is active
assigned_to query number No responsible
assigned_to_me query boolean No assigned_to_me
has_project_code query boolean No has_project_code
issued_by query integer No
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.
overdue query boolean No Build is overdue
parent query integer No
part query integer No
project_code query integer No
reference query string No Filter by exact reference
sales_order query integer No
search query string No A search term.
status query integer No Status

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": [
        {
            "barcode_hash": "string",
            "batch": "string",
            "completed": 0,
            "completion_date": "2022-04-13",
            "creation_date": "2022-04-13",
            "destination": 0,
            "issued_by": 0,
            "issued_by_detail": null,
            "link": "string",
            "notes": "string",
            "overdue": true,
            "parent": 0,
            "part": 0,
            "pk": 0,
            "priority": 0,
            "project_code": 0,
            "project_code_detail": null,
            "quantity": 10.12,
            "reference": "string",
            "responsible": 0,
            "responsible_detail": null,
            "sales_order": 0,
            "status": null,
            "status_text": "string",
            "take_from": 0,
            "target_date": "2022-04-13",
            "title": "string",
            "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/Build"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/build/

Description

API endpoint for accessing a list of Build objects.

  • GET: Return list of objects (with filters)
  • POST: Create a new Build 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

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "completed",
        "creation_date",
        "issued_by_detail",
        "overdue",
        "part",
        "pk",
        "project_code_detail",
        "quantity",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "url"
    ],
    "type": "object"
}

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "completed",
        "creation_date",
        "issued_by_detail",
        "overdue",
        "part",
        "pk",
        "project_code_detail",
        "quantity",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "url"
    ],
    "type": "object"
}

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "completed",
        "creation_date",
        "issued_by_detail",
        "overdue",
        "part",
        "pk",
        "project_code_detail",
        "quantity",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "url"
    ],
    "type": "object"
}

Response 201 Created

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "completed",
        "creation_date",
        "issued_by_detail",
        "overdue",
        "part",
        "pk",
        "project_code_detail",
        "quantity",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "url"
    ],
    "type": "object"
}

DELETE /api/build/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/build/attachment/

Description

API endpoint for listing (and creating) BuildOrderAttachment 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"
build query integer No
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.
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",
            "build": 0,
            "comment": "string",
            "filename": "string",
            "link": "string",
            "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/BuildAttachment"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/build/attachment/

Description

API endpoint for listing (and creating) BuildOrderAttachment 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

{
    "attachment": "string",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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": [
        "build",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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": [
        "build",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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": [
        "build",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

Response 201 Created

{
    "attachment": "string",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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": [
        "build",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

DELETE /api/build/attachment/{id}/

Description

Detail endpoint for a BuildOrderAttachment object.

Input parameters

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

Response 204 No Content


GET /api/build/attachment/{id}/

Description

Detail endpoint for a BuildOrderAttachment object.

Input parameters

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

Response 200 OK

{
    "attachment": "string",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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": [
        "build",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

PATCH /api/build/attachment/{id}/

Description

Detail endpoint for a BuildOrderAttachment object.

Input parameters

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

Request body

{
    "attachment": "string",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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": [
        "build",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

PUT /api/build/attachment/{id}/

Description

Detail endpoint for a BuildOrderAttachment object.

Input parameters

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

Request body

{
    "attachment": "string",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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": [
        "build",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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": [
        "build",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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": [
        "build",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

Response 200 OK

{
    "attachment": "string",
    "build": 0,
    "comment": "string",
    "filename": "string",
    "link": "string",
    "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 a BuildAttachment.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "build": {
            "type": "integer"
        },
        "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"
        },
        "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": [
        "build",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

GET /api/build/item/

Description

API endpoint for accessing a list of BuildItem objects.

  • GET: Return list of objects
  • POST: Create a new BuildItem 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"
build query integer No
build_line query integer No
install_into query integer No
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
part query integer No
stock_item query integer No
tracked query boolean No Tracked

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": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_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/BuildItem"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/build/item/

Description

API endpoint for accessing a list of BuildItem objects.

  • GET: Return list of objects
  • POST: Create a new BuildItem 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

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "build",
        "build_line",
        "install_into",
        "location_detail",
        "part_detail",
        "pk",
        "quantity",
        "stock_item",
        "stock_item_detail"
    ],
    "type": "object"
}

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "build",
        "build_line",
        "install_into",
        "location_detail",
        "part_detail",
        "pk",
        "quantity",
        "stock_item",
        "stock_item_detail"
    ],
    "type": "object"
}

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "build",
        "build_line",
        "install_into",
        "location_detail",
        "part_detail",
        "pk",
        "quantity",
        "stock_item",
        "stock_item_detail"
    ],
    "type": "object"
}

Response 201 Created

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "build",
        "build_line",
        "install_into",
        "location_detail",
        "part_detail",
        "pk",
        "quantity",
        "stock_item",
        "stock_item_detail"
    ],
    "type": "object"
}

DELETE /api/build/item/{id}/

Description

API endpoint for detail view of a BuildItem object.

Input parameters

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

Response 204 No Content


GET /api/build/item/{id}/

Description

API endpoint for detail view of a BuildItem object.

Input parameters

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

Response 200 OK

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "build",
        "build_line",
        "install_into",
        "location_detail",
        "part_detail",
        "pk",
        "quantity",
        "stock_item",
        "stock_item_detail"
    ],
    "type": "object"
}

PATCH /api/build/item/{id}/

Description

API endpoint for detail view of a BuildItem object.

Input parameters

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

Request body

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "type": "object"
}

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "type": "object"
}

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "type": "object"
}

Response 200 OK

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "build",
        "build_line",
        "install_into",
        "location_detail",
        "part_detail",
        "pk",
        "quantity",
        "stock_item",
        "stock_item_detail"
    ],
    "type": "object"
}

PUT /api/build/item/{id}/

Description

API endpoint for detail view of a BuildItem object.

Input parameters

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

Request body

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "build",
        "build_line",
        "install_into",
        "location_detail",
        "part_detail",
        "pk",
        "quantity",
        "stock_item",
        "stock_item_detail"
    ],
    "type": "object"
}

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "build",
        "build_line",
        "install_into",
        "location_detail",
        "part_detail",
        "pk",
        "quantity",
        "stock_item",
        "stock_item_detail"
    ],
    "type": "object"
}

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "build",
        "build_line",
        "install_into",
        "location_detail",
        "part_detail",
        "pk",
        "quantity",
        "stock_item",
        "stock_item_detail"
    ],
    "type": "object"
}

Response 200 OK

{
    "build": 0,
    "build_line": 0,
    "install_into": 0,
    "location_detail": null,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "stock_item": 0,
    "stock_item_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": "Serializes a BuildItem object.",
    "properties": {
        "build": {
            "readOnly": true,
            "type": "integer"
        },
        "build_line": {
            "nullable": true,
            "type": "integer"
        },
        "install_into": {
            "description": "Destination stock item",
            "nullable": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Location"
                }
            ],
            "readOnly": true
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "stock_item": {
            "description": "Source stock item",
            "type": "integer"
        },
        "stock_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItemSerializerBrief"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "build",
        "build_line",
        "install_into",
        "location_detail",
        "part_detail",
        "pk",
        "quantity",
        "stock_item",
        "stock_item_detail"
    ],
    "type": "object"
}

GET /api/build/item/{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/build/item/{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/build/item/{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/build/line/

Description

API endpoint for accessing a list of BuildLine 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"
allocated query boolean No Allocated
available query boolean No Available
bom_item query integer No
build query integer No
consumable query boolean No Consumable
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
optional query boolean No Optional
ordering query string No Which field to use when ordering the results.
search query string No A search term.
tracked query boolean No Tracked

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": [
        {
            "allocated": 10.12,
            "allocations": [
                {
                    "build": 0,
                    "build_line": 0,
                    "install_into": 0,
                    "location_detail": null,
                    "part_detail": null,
                    "pk": 0,
                    "quantity": 10.12,
                    "stock_item": 0,
                    "stock_item_detail": null
                }
            ],
            "available_stock": 10.12,
            "available_substitute_stock": 10.12,
            "available_variant_stock": 10.12,
            "bom_item": 0,
            "bom_item_detail": null,
            "build": 0,
            "external_stock": 10.12,
            "in_production": 10.12,
            "on_order": 10.12,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "total_available_stock": 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/BuildLine"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/build/line/

Description

API endpoint for accessing a list of BuildLine 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

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "allocated",
        "allocations",
        "available_stock",
        "available_substitute_stock",
        "available_variant_stock",
        "bom_item",
        "bom_item_detail",
        "build",
        "external_stock",
        "in_production",
        "on_order",
        "part_detail",
        "pk",
        "quantity",
        "total_available_stock"
    ],
    "type": "object"
}

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "allocated",
        "allocations",
        "available_stock",
        "available_substitute_stock",
        "available_variant_stock",
        "bom_item",
        "bom_item_detail",
        "build",
        "external_stock",
        "in_production",
        "on_order",
        "part_detail",
        "pk",
        "quantity",
        "total_available_stock"
    ],
    "type": "object"
}

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "allocated",
        "allocations",
        "available_stock",
        "available_substitute_stock",
        "available_variant_stock",
        "bom_item",
        "bom_item_detail",
        "build",
        "external_stock",
        "in_production",
        "on_order",
        "part_detail",
        "pk",
        "quantity",
        "total_available_stock"
    ],
    "type": "object"
}

Response 201 Created

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "allocated",
        "allocations",
        "available_stock",
        "available_substitute_stock",
        "available_variant_stock",
        "bom_item",
        "bom_item_detail",
        "build",
        "external_stock",
        "in_production",
        "on_order",
        "part_detail",
        "pk",
        "quantity",
        "total_available_stock"
    ],
    "type": "object"
}

DELETE /api/build/line/{id}/

Description

API endpoint for detail view of a BuildLine object.

Input parameters

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

Response 204 No Content


GET /api/build/line/{id}/

Description

API endpoint for detail view of a BuildLine object.

Input parameters

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

Response 200 OK

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "allocated",
        "allocations",
        "available_stock",
        "available_substitute_stock",
        "available_variant_stock",
        "bom_item",
        "bom_item_detail",
        "build",
        "external_stock",
        "in_production",
        "on_order",
        "part_detail",
        "pk",
        "quantity",
        "total_available_stock"
    ],
    "type": "object"
}

PATCH /api/build/line/{id}/

Description

API endpoint for detail view of a BuildLine object.

Input parameters

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

Request body

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "type": "object"
}

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "type": "object"
}

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "allocated",
        "allocations",
        "available_stock",
        "available_substitute_stock",
        "available_variant_stock",
        "bom_item",
        "bom_item_detail",
        "build",
        "external_stock",
        "in_production",
        "on_order",
        "part_detail",
        "pk",
        "quantity",
        "total_available_stock"
    ],
    "type": "object"
}

PUT /api/build/line/{id}/

Description

API endpoint for detail view of a BuildLine object.

Input parameters

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

Request body

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "allocated",
        "allocations",
        "available_stock",
        "available_substitute_stock",
        "available_variant_stock",
        "bom_item",
        "bom_item_detail",
        "build",
        "external_stock",
        "in_production",
        "on_order",
        "part_detail",
        "pk",
        "quantity",
        "total_available_stock"
    ],
    "type": "object"
}

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "allocated",
        "allocations",
        "available_stock",
        "available_substitute_stock",
        "available_variant_stock",
        "bom_item",
        "bom_item_detail",
        "build",
        "external_stock",
        "in_production",
        "on_order",
        "part_detail",
        "pk",
        "quantity",
        "total_available_stock"
    ],
    "type": "object"
}

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "allocated",
        "allocations",
        "available_stock",
        "available_substitute_stock",
        "available_variant_stock",
        "bom_item",
        "bom_item_detail",
        "build",
        "external_stock",
        "in_production",
        "on_order",
        "part_detail",
        "pk",
        "quantity",
        "total_available_stock"
    ],
    "type": "object"
}

Response 200 OK

{
    "allocated": 10.12,
    "allocations": [
        {
            "build": 0,
            "build_line": 0,
            "install_into": 0,
            "location_detail": null,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "stock_item": 0,
            "stock_item_detail": null
        }
    ],
    "available_stock": 10.12,
    "available_substitute_stock": 10.12,
    "available_variant_stock": 10.12,
    "bom_item": 0,
    "bom_item_detail": null,
    "build": 0,
    "external_stock": 10.12,
    "in_production": 10.12,
    "on_order": 10.12,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "total_available_stock": 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 a BuildItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "title": "Allocated Stock",
            "type": "number"
        },
        "allocations": {
            "items": {
                "$ref": "#/components/schemas/BuildItem"
            },
            "readOnly": true,
            "type": "array"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_substitute_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "bom_item": {
            "readOnly": true,
            "type": "integer"
        },
        "bom_item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BomItem"
                }
            ],
            "readOnly": true
        },
        "build": {
            "description": "Build object",
            "readOnly": true,
            "type": "integer"
        },
        "external_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "in_production": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Part"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "total_available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "allocated",
        "allocations",
        "available_stock",
        "available_substitute_stock",
        "available_variant_stock",
        "bom_item",
        "bom_item_detail",
        "build",
        "external_stock",
        "in_production",
        "on_order",
        "part_detail",
        "pk",
        "quantity",
        "total_available_stock"
    ],
    "type": "object"
}

GET /api/build/status/

Description

Retrieve information about a specific status code

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 200 OK

Response 400 Bad Request


DELETE /api/build/{id}/

Description

API endpoint for detail view of a Build object.

Input parameters

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

Response 204 No Content


GET /api/build/{id}/

Description

API endpoint for detail view of a Build object.

Input parameters

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

Response 200 OK

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "completed",
        "creation_date",
        "issued_by_detail",
        "overdue",
        "part",
        "pk",
        "project_code_detail",
        "quantity",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "url"
    ],
    "type": "object"
}

PATCH /api/build/{id}/

Description

API endpoint for detail view of a Build object.

Input parameters

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

Request body

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "completed",
        "creation_date",
        "issued_by_detail",
        "overdue",
        "part",
        "pk",
        "project_code_detail",
        "quantity",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "url"
    ],
    "type": "object"
}

PUT /api/build/{id}/

Description

API endpoint for detail view of a Build object.

Input parameters

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

Request body

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "completed",
        "creation_date",
        "issued_by_detail",
        "overdue",
        "part",
        "pk",
        "project_code_detail",
        "quantity",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "url"
    ],
    "type": "object"
}

{
    "barcode_hash": "string",
    "batch": "string",
    "completed": 0,
    "completion_date": "2022-04-13",
    "creation_date": "2022-04-13",
    "destination": 0,
    "issued_by": 0,
    "issued_by_detail": null,
    "link": "string",
    "notes": "string",
    "overdue": true,
    "parent": 0,
    "part": 0,
    "pk": 0,
    "priority": 0,
    "project_code": 0,
    "project_code_detail": null,
    "quantity": 10.12,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "sales_order": 0,
    "status": null,
    "status_text": "string",
    "take_from": 0,
    "target_date": "2022-04-13",
    "title": "string",
    "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": "Serializes a Build object.",
    "properties": {
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "batch": {
            "description": "Batch code for this build output",
            "maxLength": 100,
            "nullable": true,
            "title": "Batch Code",
            "type": "string"
        },
        "completed": {
            "description": "Number of stock items which have been completed",
            "readOnly": true,
            "title": "Completed items",
            "type": "integer"
        },
        "completion_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "creation_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "destination": {
            "description": "Select location where the completed items will be stored",
            "nullable": true,
            "title": "Destination Location",
            "type": "integer"
        },
        "issued_by": {
            "description": "User who issued this build order",
            "nullable": true,
            "type": "integer"
        },
        "issued_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "title": "External Link",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "parent": {
            "description": "BuildOrder to which this build is allocated",
            "nullable": true,
            "title": "Parent Build",
            "type": "integer"
        },
        "part": {
            "description": "Select part to build",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "priority": {
            "description": "Priority of this build order",
            "minimum": 0,
            "title": "Build Priority",
            "type": "integer"
        },
        "project_code": {
            "description": "Project code for this build order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this build order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "sales_order": {
            "description": "SalesOrder to which this build is allocated",
            "nullable": true,
            "title": "Sales Order Reference",
            "type": "integer"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/BuildStatusEnum"
                }
            ],
            "description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `30` - Cancelled\n* `40` - Complete",
            "readOnly": true,
            "title": "Build Status"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "take_from": {
            "description": "Select location to take stock from for this build (leave blank to take from any stock location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "target_date": {
            "description": "Target date for build completion. Build will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "title": "Target completion date",
            "type": "string"
        },
        "title": {
            "description": "Brief description of the build (optional)",
            "maxLength": 100,
            "title": "Description",
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "completed",
        "creation_date",