The Build Order Management section of the InvenTree API schema is documented below.
InvenTree API 342¶
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
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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 | |
ancestor |
query | integer | No | Ancestor Build | |
assigned_to |
query | integer | No | Assigned To | |
assigned_to_me |
query | boolean | No | Assigned to me | |
category |
query | integer | No | Category | |
completed_after |
query | string | No | Completed after | |
completed_before |
query | string | No | Completed before | |
created_after |
query | string | No | Created after | |
created_before |
query | string | No | Created before | |
exclude_tree |
query | integer | No | Exclude Tree | |
has_project_code |
query | boolean | No | has_project_code | |
has_start_date |
query | boolean | No | Has start date | |
has_target_date |
query | boolean | No | Has target date | |
include_variants |
query | boolean | No | Include Variants | |
issued_by |
query | integer | No | Issued By | |
limit |
query | integer | No | Number of results to return per page. | |
max_date |
query | string | No | Max Date | |
min_date |
query | string | No | Min Date | |
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. | |
outstanding |
query | boolean | No | Build is outstanding | |
overdue |
query | boolean | No | Build is overdue | |
parent |
query | integer | No | Parent Build | |
part |
query | integer | No | Part | |
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. | |
start_date_after |
query | string | No | Start date after | |
start_date_before |
query | string | No | Start date before | |
status |
query | integer | No | Order Status | |
target_date_after |
query | string | No | Target date after | |
target_date_before |
query | string | No | Target date before |
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",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Build"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"status",
"status_text"
],
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"status",
"status_text"
],
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"status",
"status_text"
],
"type": "object"
}
Response 201 Created
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"status",
"status_text"
],
"type": "object"
}
DELETE /api/build/item/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Response 204 No Content
GET /api/build/item/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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 Order | |
build_line |
query | integer | No | ||
include_variants |
query | boolean | No | Include Variants | |
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. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | Part | |
search |
query | string | No | A search term. | |
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": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"required": [
"bom_reference",
"build",
"location",
"pk",
"quantity",
"stock_item"
],
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"required": [
"bom_reference",
"build",
"location",
"pk",
"quantity",
"stock_item"
],
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"required": [
"bom_reference",
"build",
"location",
"pk",
"quantity",
"stock_item"
],
"type": "object"
}
Response 201 Created
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the response body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"required": [
"bom_reference",
"build",
"location",
"pk",
"quantity",
"stock_item"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the response body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"required": [
"bom_reference",
"build",
"location",
"pk",
"quantity",
"stock_item"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"type": "object"
}
Response 200 OK
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the response body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"required": [
"bom_reference",
"build",
"location",
"pk",
"quantity",
"stock_item"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"required": [
"bom_reference",
"build",
"location",
"pk",
"quantity",
"stock_item"
],
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"required": [
"bom_reference",
"build",
"location",
"pk",
"quantity",
"stock_item"
],
"type": "object"
}
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the request body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"required": [
"bom_reference",
"build",
"location",
"pk",
"quantity",
"stock_item"
],
"type": "object"
}
Response 200 OK
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
Schema of the response body
{
"description": "Serializes a BuildItem object, which is an allocation of a stock item against a build order.",
"properties": {
"bom_reference": {
"readOnly": true,
"type": "string"
},
"build": {
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_line": {
"nullable": true,
"type": "integer"
},
"install_into": {
"description": "Destination stock item",
"nullable": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"location_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Location"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"title": "Allocated Quantity",
"type": "number"
},
"stock_item": {
"description": "Source stock item",
"type": "integer"
},
"stock_item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"required": [
"bom_reference",
"build",
"location",
"pk",
"quantity",
"stock_item"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/build/item/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/build/item/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/build/line/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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 | |
assembly |
query | boolean | No | Assembly | |
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 | |
order_outstanding |
query | boolean | No | Order Outstanding | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | Part | |
search |
query | string | No | A search term. | |
testable |
query | boolean | No | Testable | |
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": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/BuildLine"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/build/line/¶
Description
API endpoint for accessing a list of BuildLine objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_detail",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_detail",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_detail",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
Response 201 Created
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_detail",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_detail",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
Response 200 OK
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_detail",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_detail",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_detail",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_detail",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
Response 200 OK
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"location": 0,
"location_detail": null,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"stock_item": 0,
"stock_item_detail": null,
"supplier_part_detail": null
}
],
"allow_variants": true,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"consumable": true,
"external_stock": 10.12,
"in_production": 10.12,
"inherited": true,
"on_order": 10.12,
"optional": true,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"testable": true,
"trackable": true
}
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"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"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,
"title": "BOM Item"
},
"build": {
"description": "Build object",
"readOnly": true,
"type": "integer"
},
"build_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Build"
}
],
"nullable": true,
"readOnly": true,
"title": "Build"
},
"build_reference": {
"readOnly": true,
"type": "string"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"external_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"in_production": {
"format": "double",
"readOnly": true,
"type": "number"
},
"inherited": {
"readOnly": true,
"type": "boolean"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"optional": {
"readOnly": true,
"type": "boolean"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allocations",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"bom_item_detail",
"build",
"build_reference",
"consumable",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"part_detail",
"pk",
"quantity",
"reference",
"testable",
"trackable"
],
"type": "object"
}
GET /api/build/status/¶
Description
Retrieve information about a specific status code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"status_class": "string",
"values": {}
}
Schema of the response body
{
"description": "API serializer for generic state class information.",
"properties": {
"status_class": {
"readOnly": true,
"title": "Class",
"type": "string"
},
"values": {
"additionalProperties": {
"$ref": "#/components/schemas/GenericStateValue"
},
"type": "object"
}
},
"required": [
"status_class",
"values"
],
"type": "object"
}
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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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 |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"status",
"status_text"
],
"type": "object"
}
PATCH /api/build/{id}/¶
Description
API endpoint for detail view of a Build object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"type": "object"
}
Response 200 OK
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"status",
"status_text"
],
"type": "object"
}
PUT /api/build/{id}/¶
Description
API endpoint for detail view of a Build object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"status",
"status_text"
],
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"status",
"status_text"
],
"type": "object"
}
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"status",
"status_text"
],
"type": "object"
}
Response 200 OK
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"create_child_builds": true,
"creation_date": "2022-04-13",
"destination": 0,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"quantity": 10.12,
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"sales_order": 0,
"start_date": "2022-04-13",
"status": null,
"status_custom_key": 0,
"status_text": "string",
"take_from": 0,
"target_date": "2022-04-13",
"title": "string"
}
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"
},
"create_child_builds": {
"default": false,
"description": "Automatically generate child build orders",
"type": "boolean",
"writeOnly": true
},
"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
},
"level": {
"readOnly": true,
"title": "Build Level",
"type": "integer"
},
"link": {
"description": "Link to external URL",
"format": "uri",
"maxLength": 2000,
"title": "External Link",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"overdue": {
"default": false,
"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
},
"part_name": {
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"project_code_label": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"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"
}
],
"nullable": true,
"readOnly": true
},
"sales_order": {
"description": "SalesOrder to which this build is allocated",
"nullable": true,
"title": "Sales Order Reference",
"type": "integer"
},
"start_date": {
"description": "Scheduled start date for this build order",
"format": "date",
"nullable": true,
"title": "Build start date",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BuildStatusEnum"
}
],
"description": "Build status code\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete",
"readOnly": true,
"title": "Build Status"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Production\n* `25` - On Hold\n* `30` - Cancelled\n* `40` - Complete\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
"nullable": true,
"readOnly": true,
"title": "Custom status key",
"type": "integer"
},
"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"
}
},
"required": [
"barcode_hash",
"completed",
"creation_date",
"issued_by_detail",
"level",
"overdue",
"part",
"part_detail",
"part_name",
"pk",
"quantity",
"reference",
"status",
"status_text"
],
"type": "object"
}
POST /api/build/{id}/allocate/¶
Description
API endpoint to allocate stock items to a build order.
- The BuildOrder object is specified by the URL
- Items to allocate are specified as a list called "items" with the
following options:
- bom_item: pk value of a given BomItem object (must match the part associated with this build)
- stock_item: pk value of a given StockItem object
- quantity: quantity to allocate
- output: StockItem (build order output) to allocate stock against (optional)
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"items": [
{
"build_line": 0,
"output": 0,
"quantity": "string",
"stock_item": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for allocation stock items against a build order.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildAllocationItem"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
{
"items": [
{
"build_line": 0,
"output": 0,
"quantity": "string",
"stock_item": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for allocation stock items against a build order.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildAllocationItem"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
{
"items": [
{
"build_line": 0,
"output": 0,
"quantity": "string",
"stock_item": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for allocation stock items against a build order.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildAllocationItem"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
Response 201 Created
{
"items": [
{
"build_line": 0,
"output": 0,
"quantity": "string",
"stock_item": 0
}
]
}
Schema of the response body
{
"description": "DRF serializer for allocation stock items against a build order.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildAllocationItem"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
POST /api/build/{id}/auto-allocate/¶
Description
API endpoint for 'automatically' allocating stock against a build order.
- Only looks at 'untracked' parts
- If stock exists in a single location, easy!
- If user decides that stock items are "fungible", allocate against multiple stock items
- If the user wants to, allocate substite parts if the primary parts are not available.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"exclude_location": 0,
"interchangeable": true,
"location": 0,
"optional_items": true,
"substitutes": true
}
Schema of the request body
{
"description": "DRF serializer for auto allocating stock items against a build order.",
"properties": {
"exclude_location": {
"description": "Exclude stock items from this selected location",
"nullable": true,
"type": "integer"
},
"interchangeable": {
"default": false,
"description": "Stock items in multiple locations can be used interchangeably",
"title": "Interchangeable Stock",
"type": "boolean"
},
"location": {
"description": "Stock location where parts are to be sourced (leave blank to take from any location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"optional_items": {
"default": false,
"description": "Allocate optional BOM items to build order",
"type": "boolean"
},
"substitutes": {
"default": true,
"description": "Allow allocation of substitute parts",
"title": "Substitute Stock",
"type": "boolean"
}
},
"type": "object"
}
{
"exclude_location": 0,
"interchangeable": true,
"location": 0,
"optional_items": true,
"substitutes": true
}
Schema of the request body
{
"description": "DRF serializer for auto allocating stock items against a build order.",
"properties": {
"exclude_location": {
"description": "Exclude stock items from this selected location",
"nullable": true,
"type": "integer"
},
"interchangeable": {
"default": false,
"description": "Stock items in multiple locations can be used interchangeably",
"title": "Interchangeable Stock",
"type": "boolean"
},
"location": {
"description": "Stock location where parts are to be sourced (leave blank to take from any location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"optional_items": {
"default": false,
"description": "Allocate optional BOM items to build order",
"type": "boolean"
},
"substitutes": {
"default": true,
"description": "Allow allocation of substitute parts",
"title": "Substitute Stock",
"type": "boolean"
}
},
"type": "object"
}
{
"exclude_location": 0,
"interchangeable": true,
"location": 0,
"optional_items": true,
"substitutes": true
}
Schema of the request body
{
"description": "DRF serializer for auto allocating stock items against a build order.",
"properties": {
"exclude_location": {
"description": "Exclude stock items from this selected location",
"nullable": true,
"type": "integer"
},
"interchangeable": {
"default": false,
"description": "Stock items in multiple locations can be used interchangeably",
"title": "Interchangeable Stock",
"type": "boolean"
},
"location": {
"description": "Stock location where parts are to be sourced (leave blank to take from any location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"optional_items": {
"default": false,
"description": "Allocate optional BOM items to build order",
"type": "boolean"
},
"substitutes": {
"default": true,
"description": "Allow allocation of substitute parts",
"title": "Substitute Stock",
"type": "boolean"
}
},
"type": "object"
}
Response 201 Created
{
"exclude_location": 0,
"interchangeable": true,
"location": 0,
"optional_items": true,
"substitutes": true
}
Schema of the response body
{
"description": "DRF serializer for auto allocating stock items against a build order.",
"properties": {
"exclude_location": {
"description": "Exclude stock items from this selected location",
"nullable": true,
"type": "integer"
},
"interchangeable": {
"default": false,
"description": "Stock items in multiple locations can be used interchangeably",
"title": "Interchangeable Stock",
"type": "boolean"
},
"location": {
"description": "Stock location where parts are to be sourced (leave blank to take from any location)",
"nullable": true,
"title": "Source Location",
"type": "integer"
},
"optional_items": {
"default": false,
"description": "Allocate optional BOM items to build order",
"type": "boolean"
},
"substitutes": {
"default": true,
"description": "Allow allocation of substitute parts",
"title": "Substitute Stock",
"type": "boolean"
}
},
"type": "object"
}
POST /api/build/{id}/cancel/¶
Description
API endpoint for cancelling a BuildOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"remove_allocated_stock": true,
"remove_incomplete_outputs": true
}
Schema of the request body
{
"description": "Cancel an active BuildOrder.",
"properties": {
"remove_allocated_stock": {
"default": false,
"description": "Consume any stock which has already been allocated to this build",
"title": "Consume Allocated Stock",
"type": "boolean"
},
"remove_incomplete_outputs": {
"default": false,
"description": "Delete any build outputs which have not been completed",
"type": "boolean"
}
},
"type": "object"
}
{
"remove_allocated_stock": true,
"remove_incomplete_outputs": true
}
Schema of the request body
{
"description": "Cancel an active BuildOrder.",
"properties": {
"remove_allocated_stock": {
"default": false,
"description": "Consume any stock which has already been allocated to this build",
"title": "Consume Allocated Stock",
"type": "boolean"
},
"remove_incomplete_outputs": {
"default": false,
"description": "Delete any build outputs which have not been completed",
"type": "boolean"
}
},
"type": "object"
}
{
"remove_allocated_stock": true,
"remove_incomplete_outputs": true
}
Schema of the request body
{
"description": "Cancel an active BuildOrder.",
"properties": {
"remove_allocated_stock": {
"default": false,
"description": "Consume any stock which has already been allocated to this build",
"title": "Consume Allocated Stock",
"type": "boolean"
},
"remove_incomplete_outputs": {
"default": false,
"description": "Delete any build outputs which have not been completed",
"type": "boolean"
}
},
"type": "object"
}
Response 201 Created
{
"remove_allocated_stock": true,
"remove_incomplete_outputs": true
}
Schema of the response body
{
"description": "Cancel an active BuildOrder.",
"properties": {
"remove_allocated_stock": {
"default": false,
"description": "Consume any stock which has already been allocated to this build",
"title": "Consume Allocated Stock",
"type": "boolean"
},
"remove_incomplete_outputs": {
"default": false,
"description": "Delete any build outputs which have not been completed",
"type": "boolean"
}
},
"type": "object"
}
POST /api/build/{id}/complete/¶
Description
API endpoint for completing build outputs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"accept_incomplete_allocation": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0
}
],
"status_custom_key": 0
}
Schema of the request body
{
"description": "DRF serializer for completing one or more build outputs.",
"properties": {
"accept_incomplete_allocation": {
"default": false,
"description": "Complete outputs if stock has not been fully allocated",
"type": "boolean"
},
"location": {
"description": "Location for completed build outputs",
"type": "integer"
},
"notes": {
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
},
"status_custom_key": {
"default": 10,
"description": "Stock item status code\n\n* `10` - OK\n* `50` - Attention needed\n* `55` - Damaged\n* `60` - Destroyed\n* `65` - Rejected\n* `70` - Lost\n* `75` - Quarantined\n* `85` - Returned\n\nAdditional custom status keys may be retrieved from the 'stock_status_retrieve' call.",
"title": "Status",
"type": "integer"
}
},
"required": [
"location",
"outputs"
],
"type": "object"
}
{
"accept_incomplete_allocation": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0
}
],
"status_custom_key": 0
}
Schema of the request body
{
"description": "DRF serializer for completing one or more build outputs.",
"properties": {
"accept_incomplete_allocation": {
"default": false,
"description": "Complete outputs if stock has not been fully allocated",
"type": "boolean"
},
"location": {
"description": "Location for completed build outputs",
"type": "integer"
},
"notes": {
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
},
"status_custom_key": {
"default": 10,
"description": "Stock item status code\n\n* `10` - OK\n* `50` - Attention needed\n* `55` - Damaged\n* `60` - Destroyed\n* `65` - Rejected\n* `70` - Lost\n* `75` - Quarantined\n* `85` - Returned\n\nAdditional custom status keys may be retrieved from the 'stock_status_retrieve' call.",
"title": "Status",
"type": "integer"
}
},
"required": [
"location",
"outputs"
],
"type": "object"
}
{
"accept_incomplete_allocation": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0
}
],
"status_custom_key": 0
}
Schema of the request body
{
"description": "DRF serializer for completing one or more build outputs.",
"properties": {
"accept_incomplete_allocation": {
"default": false,
"description": "Complete outputs if stock has not been fully allocated",
"type": "boolean"
},
"location": {
"description": "Location for completed build outputs",
"type": "integer"
},
"notes": {
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
},
"status_custom_key": {
"default": 10,
"description": "Stock item status code\n\n* `10` - OK\n* `50` - Attention needed\n* `55` - Damaged\n* `60` - Destroyed\n* `65` - Rejected\n* `70` - Lost\n* `75` - Quarantined\n* `85` - Returned\n\nAdditional custom status keys may be retrieved from the 'stock_status_retrieve' call.",
"title": "Status",
"type": "integer"
}
},
"required": [
"location",
"outputs"
],
"type": "object"
}
Response 201 Created
{
"accept_incomplete_allocation": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0
}
],
"status_custom_key": 0
}
Schema of the response body
{
"description": "DRF serializer for completing one or more build outputs.",
"properties": {
"accept_incomplete_allocation": {
"default": false,
"description": "Complete outputs if stock has not been fully allocated",
"type": "boolean"
},
"location": {
"description": "Location for completed build outputs",
"type": "integer"
},
"notes": {
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
},
"status_custom_key": {
"default": 10,
"description": "Stock item status code\n\n* `10` - OK\n* `50` - Attention needed\n* `55` - Damaged\n* `60` - Destroyed\n* `65` - Rejected\n* `70` - Lost\n* `75` - Quarantined\n* `85` - Returned\n\nAdditional custom status keys may be retrieved from the 'stock_status_retrieve' call.",
"title": "Status",
"type": "integer"
}
},
"required": [
"location",
"outputs"
],
"type": "object"
}
POST /api/build/{id}/create-output/¶
Description
API endpoint for creating new build output(s).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"auto_allocate": true,
"batch_code": "string",
"location": 0,
"quantity": "string",
"serial_numbers": "string"
}
Schema of the request body
{
"description": "Serializer for creating a new BuildOutput against a BuildOrder.\n\nURL pattern is \"/api/build/<pk>/create-output/\", where <pk> is the PK of a Build.\n\nThe Build object is provided to the serializer context.",
"properties": {
"auto_allocate": {
"default": false,
"description": "Automatically allocate required items with matching serial numbers",
"nullable": true,
"title": "Auto Allocate Serial Numbers",
"type": "boolean"
},
"batch_code": {
"description": "Batch code for this build output",
"type": "string"
},
"location": {
"description": "Stock location for build output",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for build output",
"format": "decimal",
"pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$",
"type": "string"
},
"serial_numbers": {
"description": "Enter serial numbers for build outputs",
"type": "string"
}
},
"required": [
"quantity"
],
"type": "object"
}
{
"auto_allocate": true,
"batch_code": "string",
"location": 0,
"quantity": "string",
"serial_numbers": "string"
}
Schema of the request body
{
"description": "Serializer for creating a new BuildOutput against a BuildOrder.\n\nURL pattern is \"/api/build/<pk>/create-output/\", where <pk> is the PK of a Build.\n\nThe Build object is provided to the serializer context.",
"properties": {
"auto_allocate": {
"default": false,
"description": "Automatically allocate required items with matching serial numbers",
"nullable": true,
"title": "Auto Allocate Serial Numbers",
"type": "boolean"
},
"batch_code": {
"description": "Batch code for this build output",
"type": "string"
},
"location": {
"description": "Stock location for build output",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for build output",
"format": "decimal",
"pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$",
"type": "string"
},
"serial_numbers": {
"description": "Enter serial numbers for build outputs",
"type": "string"
}
},
"required": [
"quantity"
],
"type": "object"
}
{
"auto_allocate": true,
"batch_code": "string",
"location": 0,
"quantity": "string",
"serial_numbers": "string"
}
Schema of the request body
{
"description": "Serializer for creating a new BuildOutput against a BuildOrder.\n\nURL pattern is \"/api/build/<pk>/create-output/\", where <pk> is the PK of a Build.\n\nThe Build object is provided to the serializer context.",
"properties": {
"auto_allocate": {
"default": false,
"description": "Automatically allocate required items with matching serial numbers",
"nullable": true,
"title": "Auto Allocate Serial Numbers",
"type": "boolean"
},
"batch_code": {
"description": "Batch code for this build output",
"type": "string"
},
"location": {
"description": "Stock location for build output",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for build output",
"format": "decimal",
"pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$",
"type": "string"
},
"serial_numbers": {
"description": "Enter serial numbers for build outputs",
"type": "string"
}
},
"required": [
"quantity"
],
"type": "object"
}
Response 201 Created
{
"auto_allocate": true,
"batch_code": "string",
"location": 0,
"quantity": "string",
"serial_numbers": "string"
}
Schema of the response body
{
"description": "Serializer for creating a new BuildOutput against a BuildOrder.\n\nURL pattern is \"/api/build/<pk>/create-output/\", where <pk> is the PK of a Build.\n\nThe Build object is provided to the serializer context.",
"properties": {
"auto_allocate": {
"default": false,
"description": "Automatically allocate required items with matching serial numbers",
"nullable": true,
"title": "Auto Allocate Serial Numbers",
"type": "boolean"
},
"batch_code": {
"description": "Batch code for this build output",
"type": "string"
},
"location": {
"description": "Stock location for build output",
"nullable": true,
"type": "integer"
},
"quantity": {
"description": "Enter quantity for build output",
"format": "decimal",
"pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$",
"type": "string"
},
"serial_numbers": {
"description": "Enter serial numbers for build outputs",
"type": "string"
}
},
"required": [
"quantity"
],
"type": "object"
}
POST /api/build/{id}/delete-outputs/¶
Description
API endpoint for deleting multiple build outputs.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"outputs": [
{
"output": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for deleting (cancelling) one or more build outputs.",
"properties": {
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
}
},
"required": [
"outputs"
],
"type": "object"
}
{
"outputs": [
{
"output": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for deleting (cancelling) one or more build outputs.",
"properties": {
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
}
},
"required": [
"outputs"
],
"type": "object"
}
{
"outputs": [
{
"output": 0
}
]
}
Schema of the request body
{
"description": "DRF serializer for deleting (cancelling) one or more build outputs.",
"properties": {
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
}
},
"required": [
"outputs"
],
"type": "object"
}
Response 201 Created
{
"outputs": [
{
"output": 0
}
]
}
Schema of the response body
{
"description": "DRF serializer for deleting (cancelling) one or more build outputs.",
"properties": {
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutput"
},
"type": "array"
}
},
"required": [
"outputs"
],
"type": "object"
}
POST /api/build/{id}/finish/¶
Description
API endpoint for marking a build as finished (completed).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"accept_incomplete": true,
"accept_overallocated": null,
"accept_unallocated": true
}
Schema of the request body
{
"description": "DRF serializer for marking a BuildOrder as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Accept that the required number of build outputs have not been completed",
"type": "boolean"
},
"accept_overallocated": {
"allOf": [
{
"$ref": "#/components/schemas/AcceptOverallocatedEnum"
}
],
"default": "reject",
"description": "How do you want to handle extra stock items assigned to the build order\n\n* `reject` - Not permitted\n* `accept` - Accept as consumed by this build order\n* `trim` - Deallocate before completing this build order",
"title": "Overallocated Stock"
},
"accept_unallocated": {
"default": false,
"description": "Accept that stock items have not been fully allocated to this build order",
"type": "boolean"
}
},
"type": "object"
}
{
"accept_incomplete": true,
"accept_overallocated": null,
"accept_unallocated": true
}
Schema of the request body
{
"description": "DRF serializer for marking a BuildOrder as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Accept that the required number of build outputs have not been completed",
"type": "boolean"
},
"accept_overallocated": {
"allOf": [
{
"$ref": "#/components/schemas/AcceptOverallocatedEnum"
}
],
"default": "reject",
"description": "How do you want to handle extra stock items assigned to the build order\n\n* `reject` - Not permitted\n* `accept` - Accept as consumed by this build order\n* `trim` - Deallocate before completing this build order",
"title": "Overallocated Stock"
},
"accept_unallocated": {
"default": false,
"description": "Accept that stock items have not been fully allocated to this build order",
"type": "boolean"
}
},
"type": "object"
}
{
"accept_incomplete": true,
"accept_overallocated": null,
"accept_unallocated": true
}
Schema of the request body
{
"description": "DRF serializer for marking a BuildOrder as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Accept that the required number of build outputs have not been completed",
"type": "boolean"
},
"accept_overallocated": {
"allOf": [
{
"$ref": "#/components/schemas/AcceptOverallocatedEnum"
}
],
"default": "reject",
"description": "How do you want to handle extra stock items assigned to the build order\n\n* `reject` - Not permitted\n* `accept` - Accept as consumed by this build order\n* `trim` - Deallocate before completing this build order",
"title": "Overallocated Stock"
},
"accept_unallocated": {
"default": false,
"description": "Accept that stock items have not been fully allocated to this build order",
"type": "boolean"
}
},
"type": "object"
}
Response 201 Created
{
"accept_incomplete": true,
"accept_overallocated": null,
"accept_unallocated": true
}
Schema of the response body
{
"description": "DRF serializer for marking a BuildOrder as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Accept that the required number of build outputs have not been completed",
"type": "boolean"
},
"accept_overallocated": {
"allOf": [
{
"$ref": "#/components/schemas/AcceptOverallocatedEnum"
}
],
"default": "reject",
"description": "How do you want to handle extra stock items assigned to the build order\n\n* `reject` - Not permitted\n* `accept` - Accept as consumed by this build order\n* `trim` - Deallocate before completing this build order",
"title": "Overallocated Stock"
},
"accept_unallocated": {
"default": false,
"description": "Accept that stock items have not been fully allocated to this build order",
"type": "boolean"
}
},
"type": "object"
}
POST /api/build/{id}/hold/¶
Description
API endpoint for placing a BuildOrder on hold.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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 201 Created
POST /api/build/{id}/issue/¶
Description
API endpoint for issuing a BuildOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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 201 Created
GET /api/build/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/build/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/build/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
POST /api/build/{id}/scrap-outputs/¶
Description
API endpoint for scrapping build output(s).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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
{
"discard_allocations": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0,
"quantity": "string"
}
]
}
Schema of the request body
{
"description": "Scrapping one or more build outputs.",
"properties": {
"discard_allocations": {
"default": false,
"description": "Discard any stock allocations for scrapped outputs",
"type": "boolean"
},
"location": {
"description": "Stock location for scrapped outputs",
"type": "integer"
},
"notes": {
"description": "Reason for scrapping build output(s)",
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutputQuantity"
},
"type": "array"
}
},
"required": [
"location",
"notes",
"outputs"
],
"type": "object"
}
{
"discard_allocations": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0,
"quantity": "string"
}
]
}
Schema of the request body
{
"description": "Scrapping one or more build outputs.",
"properties": {
"discard_allocations": {
"default": false,
"description": "Discard any stock allocations for scrapped outputs",
"type": "boolean"
},
"location": {
"description": "Stock location for scrapped outputs",
"type": "integer"
},
"notes": {
"description": "Reason for scrapping build output(s)",
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutputQuantity"
},
"type": "array"
}
},
"required": [
"location",
"notes",
"outputs"
],
"type": "object"
}
{
"discard_allocations": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0,
"quantity": "string"
}
]
}
Schema of the request body
{
"description": "Scrapping one or more build outputs.",
"properties": {
"discard_allocations": {
"default": false,
"description": "Discard any stock allocations for scrapped outputs",
"type": "boolean"
},
"location": {
"description": "Stock location for scrapped outputs",
"type": "integer"
},
"notes": {
"description": "Reason for scrapping build output(s)",
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutputQuantity"
},
"type": "array"
}
},
"required": [
"location",
"notes",
"outputs"
],
"type": "object"
}
Response 201 Created
{
"discard_allocations": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0,
"quantity": "string"
}
]
}
Schema of the response body
{
"description": "Scrapping one or more build outputs.",
"properties": {
"discard_allocations": {
"default": false,
"description": "Discard any stock allocations for scrapped outputs",
"type": "boolean"
},
"location": {
"description": "Stock location for scrapped outputs",
"type": "integer"
},
"notes": {
"description": "Reason for scrapping build output(s)",
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/BuildOutputQuantity"
},
"type": "array"
}
},
"required": [
"location",
"notes",
"outputs"
],
"type": "object"
}
POST /api/build/{id}/unallocate/¶
Description
API endpoint for unallocating stock items from a build order.
- The BuildOrder object is specified by the URL
- "output" (StockItem) can optionally be specified
- "bom_item" can optionally be specified
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | 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_line": 0,
"output": 0
}
Schema of the request body
{
"description": "DRF serializer for unallocating stock from a BuildOrder.\n\nAllocated stock can be unallocated with a number of filters:\n\n- output: Filter against a particular build output (blank = untracked stock)\n- bom_item: Filter against a particular BOM line item",
"properties": {
"build_line": {
"nullable": true,
"type": "integer"
},
"output": {
"nullable": true,
"title": "Build output",
"type": "integer"
}
},
"type": "object"
}
{
"build_line": 0,
"output": 0
}
Schema of the request body
{
"description": "DRF serializer for unallocating stock from a BuildOrder.\n\nAllocated stock can be unallocated with a number of filters:\n\n- output: Filter against a particular build output (blank = untracked stock)\n- bom_item: Filter against a particular BOM line item",
"properties": {
"build_line": {
"nullable": true,
"type": "integer"
},
"output": {
"nullable": true,
"title": "Build output",
"type": "integer"
}
},
"type": "object"
}
{
"build_line": 0,
"output": 0
}
Schema of the request body
{
"description": "DRF serializer for unallocating stock from a BuildOrder.\n\nAllocated stock can be unallocated with a number of filters:\n\n- output: Filter against a particular build output (blank = untracked stock)\n- bom_item: Filter against a particular BOM line item",
"properties": {
"build_line": {
"nullable": true,
"type": "integer"
},
"output": {
"nullable": true,
"title": "Build output",
"type": "integer"
}
},
"type": "object"
}
Response 201 Created
{
"build_line": 0,
"output": 0
}
Schema of the response body
{
"description": "DRF serializer for unallocating stock from a BuildOrder.\n\nAllocated stock can be unallocated with a number of filters:\n\n- output: Filter against a particular build output (blank = untracked stock)\n- bom_item: Filter against a particular BOM line item",
"properties": {
"build_line": {
"nullable": true,
"type": "integer"
},
"output": {
"nullable": true,
"title": "Build output",
"type": "integer"
}
},
"type": "object"
}
Schemas¶
AcceptOverallocatedEnum¶
Type: string
BomItem¶
| Name | Type |
|---|---|
allow_variants |
boolean |
available_stock |
number(double)| null |
available_substitute_stock |
number(double)| null |
available_variant_stock |
number(double)| null |
building |
number(double)| null |
can_build |
number(double)| null |
consumable |
boolean |
external_stock |
number(double)| null |
inherited |
boolean |
note |
string |
on_order |
number(double)| null |
optional |
boolean |
overage |
string |
part |
integer |
part_detail |
|
pk |
integer |
pricing_max |
string(decimal)| null |
pricing_max_total |
string(decimal)| null |
pricing_min |
string(decimal)| null |
pricing_min_total |
string(decimal)| null |
pricing_updated |
string(date-time)| null |
quantity |
number(double) |
reference |
string |
sub_part |
integer |
sub_part_detail |
|
substitutes |
Array<BomItemSubstitute> |
validated |
boolean |
BomItemSubstitute¶
| Name | Type |
|---|---|
bom_item |
integer |
part |
integer |
part_detail |
|
pk |
integer |
Build¶
| Name | Type |
|---|---|
barcode_hash |
string |
batch |
string| null |
completed |
integer |
completion_date |
string(date)| null |
create_child_builds |
boolean |
creation_date |
string(date) |
destination |
integer| null |
issued_by |
integer| null |
issued_by_detail |
|
level |
integer |
link |
string(uri) |
notes |
string| null |
overdue |
boolean |
parent |
integer| null |
part |
integer |
part_detail |
|
part_name |
string |
pk |
integer |
priority |
integer |
project_code |
integer| null |
project_code_detail |
|
project_code_label |
string| null |
quantity |
number(double) |
reference |
string |
responsible |
integer| null |
responsible_detail |
|
sales_order |
integer| null |
start_date |
string(date)| null |
status |
|
status_custom_key |
integer| null |
status_text |
string |
take_from |
integer| null |
target_date |
string(date)| null |
title |
string |
BuildAllocation¶
| Name | Type |
|---|---|
items |
Array<BuildAllocationItem> |
BuildAllocationItem¶
| Name | Type |
|---|---|
build_line |
integer |
output |
integer| null |
quantity |
string(decimal) |
stock_item |
integer |
BuildAutoAllocation¶
| Name | Type |
|---|---|
exclude_location |
integer| null |
interchangeable |
boolean |
location |
integer| null |
optional_items |
boolean |
substitutes |
boolean |
BuildCancel¶
| Name | Type |
|---|---|
remove_allocated_stock |
boolean |
remove_incomplete_outputs |
boolean |
BuildComplete¶
| Name | Type |
|---|---|
accept_incomplete |
boolean |
accept_overallocated |
|
accept_unallocated |
boolean |
BuildItem¶
| Name | Type |
|---|---|
bom_reference |
string |
build |
integer |
build_detail |
|
build_line |
integer| null |
install_into |
integer| null |
location |
integer |
location_detail |
|
part_detail |
|
pk |
integer |
quantity |
number(double) |
stock_item |
integer |
stock_item_detail |
|
supplier_part_detail |
BuildLine¶
| Name | Type |
|---|---|
allocated |
number(double) |
allocations |
Array<BuildItem> |
allow_variants |
boolean |
available_stock |
number(double) |
available_substitute_stock |
number(double) |
available_variant_stock |
number(double) |
bom_item |
integer |
bom_item_detail |
|
build |
integer |
build_detail |
|
build_reference |
string |
consumable |
boolean |
external_stock |
number(double) |
in_production |
number(double) |
inherited |
boolean |
on_order |
number(double) |
optional |
boolean |
part |
integer |
part_detail |
|
pk |
integer |
quantity |
number(double) |
reference |
string |
testable |
boolean |
trackable |
boolean |
BuildOutput¶
| Name | Type |
|---|---|
output |
integer |
BuildOutputComplete¶
| Name | Type |
|---|---|
accept_incomplete_allocation |
boolean |
location |
integer |
notes |
string |
outputs |
Array<BuildOutput> |
status_custom_key |
integer |
BuildOutputCreate¶
| Name | Type |
|---|---|
auto_allocate |
boolean| null |
batch_code |
string |
location |
integer| null |
quantity |
string(decimal) |
serial_numbers |
string |
BuildOutputDelete¶
| Name | Type |
|---|---|
outputs |
Array<BuildOutput> |
BuildOutputQuantity¶
| Name | Type |
|---|---|
output |
integer |
quantity |
string(decimal) |
BuildOutputScrap¶
| Name | Type |
|---|---|
discard_allocations |
boolean |
location |
integer |
notes |
string |
outputs |
Array<BuildOutputQuantity> |
BuildStatusEnum¶
Type: integer
BuildUnallocation¶
| Name | Type |
|---|---|
build_line |
integer| null |
output |
integer| null |
BulkRequest¶
| Name | Type |
|---|---|
filters |
|
items |
Array<integer> |
CompanyBrief¶
| Name | Type |
|---|---|
active |
boolean |
currency |
string |
description |
string |
image |
string(uri) |
name |
string |
pk |
integer |
thumbnail |
string |
GenericStateClass¶
| Name | Type |
|---|---|
status_class |
string |
values |
GenericStateValue¶
| Name | Type |
|---|---|
color |
string |
custom |
boolean |
key |
integer |
label |
string |
logical_key |
string |
name |
string |
LocationBrief¶
| Name | Type |
|---|---|
name |
string |
pathstring |
string |
pk |
integer |
ManufacturerPart¶
| Name | Type |
|---|---|
barcode_hash |
string |
description |
string| null |
link |
string(uri)| null |
manufacturer |
integer |
manufacturer_detail |
|
MPN |
string| null |
notes |
string| null |
part |
integer |
part_detail |
|
pk |
integer |
pretty_name |
string| null |
tags |
Array<string> |
Metadata¶
| Name | Type |
|---|---|
metadata |
Owner¶
| Name | Type |
|---|---|
label |
string |
name |
string |
owner_id |
integer| null |
owner_model |
string |
pk |
integer |
PaginatedBuildItemList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<BuildItem> |
PaginatedBuildLineList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<BuildLine> |
PaginatedBuildList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<Build> |
PartBrief¶
| Name | Type |
|---|---|
active |
boolean |
assembly |
boolean |
barcode_hash |
string |
category_default_location |
integer| null |
component |
boolean |
default_expiry |
integer |
default_location |
integer| null |
description |
string |
full_name |
string |
image |
string(uri)| null |
IPN |
string| null |
is_template |
boolean |
locked |
boolean |
name |
string |
pk |
integer |
pricing_max |
string(decimal)| null |
pricing_min |
string(decimal)| null |
purchaseable |
boolean |
revision |
string| null |
salable |
boolean |
testable |
boolean |
thumbnail |
string |
trackable |
boolean |
units |
string| null |
virtual |
boolean |
PatchedBuild¶
| Name | Type |
|---|---|
barcode_hash |
string |
batch |
string| null |
completed |
integer |
completion_date |
string(date)| null |
create_child_builds |
boolean |
creation_date |
string(date) |
destination |
integer| null |
issued_by |
integer| null |
issued_by_detail |
|
level |
integer |
link |
string(uri) |
notes |
string| null |
overdue |
boolean |
parent |
integer| null |
part |
integer |
part_detail |
|
part_name |
string |
pk |
integer |
priority |
integer |
project_code |
integer| null |
project_code_detail |
|
project_code_label |
string| null |
quantity |
number(double) |
reference |
string |
responsible |
integer| null |
responsible_detail |
|
sales_order |
integer| null |
start_date |
string(date)| null |
status |
|
status_custom_key |
integer| null |
status_text |
string |
take_from |
integer| null |
target_date |
string(date)| null |
title |
string |
PatchedBuildItem¶
| Name | Type |
|---|---|
bom_reference |
string |
build |
integer |
build_detail |
|
build_line |
integer| null |
install_into |
integer| null |
location |
integer |
location_detail |
|
part_detail |
|
pk |
integer |
quantity |
number(double) |
stock_item |
integer |
stock_item_detail |
|
supplier_part_detail |
PatchedBuildLine¶
| Name | Type |
|---|---|
allocated |
number(double) |
allocations |
Array<BuildItem> |
allow_variants |
boolean |
available_stock |
number(double) |
available_substitute_stock |
number(double) |
available_variant_stock |
number(double) |
bom_item |
integer |
bom_item_detail |
|
build |
integer |
build_detail |
|
build_reference |
string |
consumable |
boolean |
external_stock |
number(double) |
in_production |
number(double) |
inherited |
boolean |
on_order |
number(double) |
optional |
boolean |
part |
integer |
part_detail |
|
pk |
integer |
quantity |
number(double) |
reference |
string |
testable |
boolean |
trackable |
boolean |
PatchedMetadata¶
| Name | Type |
|---|---|
metadata |
ProjectCode¶
| Name | Type |
|---|---|
code |
string |
description |
string |
pk |
integer |
responsible |
integer| null |
responsible_detail |
StockItemSerializerBrief¶
| Name | Type |
|---|---|
barcode_hash |
string |
batch |
string| null |
location |
integer| null |
part |
integer |
part_name |
string |
pk |
integer |
quantity |
number(double) |
serial |
string| null |
supplier_part |
integer| null |
SupplierPart¶
| Name | Type |
|---|---|
active |
boolean |
availability_updated |
string(date-time)| null |
available |
number(double) |
barcode_hash |
string |
description |
string| null |
in_stock |
number(double)| null |
link |
string(uri)| null |
manufacturer_detail |
|
manufacturer_part |
integer| null |
manufacturer_part_detail |
|
MPN |
string| null |
note |
string| null |
notes |
string| null |
on_order |
number(double)| null |
pack_quantity |
string |
pack_quantity_native |
number(double) |
packaging |
string| null |
part |
integer |
part_detail |
|
pk |
integer |
pretty_name |
string| null |
SKU |
string |
supplier |
integer |
supplier_detail |
|
tags |
Array<string> |
updated |
string(date-time)| null |
User¶
| Name | Type |
|---|---|
email |
string(email) |
first_name |
string |
last_name |
string |
pk |
integer |
username |
string |
Common responses¶
This section describes common responses that are reused across operations.
allauth.AddAuthenticatorConflict¶
The account prohibits adding an authenticator, e.g. because of an unverified email address.
Schema of the response body
null
allauth.AddWebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.\n",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data",
"meta"
],
"type": "object"
}
allauth.Authenticated¶
The user is authenticated.
Schema of the response body
null
allauth.AuthenticatedByCode¶
Authenticated by code.
{
"summary": "Authenticated by code.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "code"
}
],
"user": {
"display": "wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPassword¶
Authenticated by password.
{
"summary": "Authenticated by password.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
}
],
"user": {
"display": "wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPasswordAnd2FA¶
Authenticated by password and 2FA.
{
"summary": "Fully authenticated using by password and 2FA.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.Authentication¶
Not authenticated.
{
"summary": "Reauthentication required\n",
"value": {
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
}
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending 2FA\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "mfa_authenticate",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending email verification\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "verify_email",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending provider signup\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "provider_signup",
"is_pending": true,
"provider": {
"client_id": "123.apps.googleusercontent.com",
"flows": [
"provider_redirect",
"provider_token"
],
"id": "google",
"name": "Google"
}
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.AuthenticationOrReauthentication¶
The response indicates authentication or re-authentication is required.
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/allauth.AuthenticationResponse"
},
{
"$ref": "#/components/schemas/allauth.ReauthenticationResponse"
}
]
}
allauth.Authenticators¶
List of authenticators.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.AuthenticatorList"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.Configuration¶
The django-allauth configuration.
Schema of the response body
null
allauth.EmailAddresses¶
List of email addresses.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.EmailVerificationInfo¶
Email verification information.
Schema of the response body
null
allauth.Error¶
An input error occurred.
Schema of the response body
null
allauth.Forbidden¶
A forbidden response.
Schema of the response body
null
allauth.NotFound¶
Not found.
{
"status": 0
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.PasswordResetInfo¶
Information about the password reset key.
{
"data": {
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ProviderAccounts¶
List of third-party provider accounts.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ReauthenticationRequired¶
The response indicates reauthentication is required.
{
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
Schema of the response body
allauth.RecoveryCodes¶
Information on the recovery codes.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.SensitiveRecoveryCodesAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.SessionGone¶
The response indicates session is invalid or no longer exists.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.Sessions¶
List of sessions.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.Session"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.StatusOK¶
A success response.
{
"status": null
}
Schema of the response body
{
"properties": {
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.TOTPAuthenticator¶
Information on the TOTP authenticator.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.TOTPAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.TOTPAuthenticatorNotFound¶
No TOTP authenticator has been set up.
{
"meta": {
"secret": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"totp_url": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example"
},
"status": 0
}
Schema of the response body
{
"properties": {
"meta": {
"properties": {
"secret": {
"description": "A TOTP secret that can be used to setup a new authenticator.\n",
"example": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"type": "string"
},
"totp_url": {
"description": "otpauth URI from which a QR code can be generated and scanned by OTP clients.\n",
"example": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example",
"type": "string"
}
},
"required": [
"secret",
"totp_url"
],
"type": "object"
},
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status",
"meta"
],
"type": "object"
}
allauth.Unauthenticated¶
There is no authenticated session.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.WebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnCreationOptionsResponse¶
WebAuthn credential creation options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialCreationOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnRequestOptionsResponse¶
WebAuthn credential request options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialRequestOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
Common parameters¶
This section describes common parameters that are reused across operations.
allauth.EmailVerificationKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Email-Verification-Key |
header | string | No |
allauth.PasswordResetKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Password-Reset-Key |
header | string | No |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| oauth2 | oauth2 | ||
| tokenAuth | apiKey | Token-based authentication with required prefix "Token" |
More documentation¶
More information about InvenTree in the official docs
For more information: https://docs.inventree.org