The Build Order Management section of the InvenTree API schema is documented below.
InvenTree API 477¶
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 | |
external |
query | boolean | No | ||
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 | ||
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 | |
part_detail |
query | boolean | True | No | Include detailed information about the related part in the response |
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. Searched fields: part__IPN, part__description, part__name, priority, project_code__code, reference, title. | |
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 |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 4,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 249,
"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",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 293,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 102,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 169,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 234,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 54,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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"
}
Responses
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 44,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 25,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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"
}
Responses
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_detail |
query | boolean | False | No | Include detailed information about the associated build order. |
build_line |
query | integer | No | ||
include_variants |
query | boolean | No | Include Variants | |
install_into |
query | integer | No | ||
install_into_detail |
query | boolean | False | No | Include detailed information about the build output for this build item. |
limit |
query | integer | No | Number of results to return per page. | |
location |
query | integer | No | Location | |
location_detail |
query | boolean | False | No | Include detailed information about the location of the allocated stock item. |
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. | |
output |
query | integer | No | Filter by output stock item ID. Use 'null' to find uninstalled build items. | |
part |
query | integer | No | Part | |
part_detail |
query | boolean | False | No | Include detailed information about the part associated with this build item. |
search |
query | string | No | A search term. Searched fields: build_line__bom_item__reference, stock_item__part__IPN, stock_item__part__name, stock_item__supplier_part__SKU. | |
stock_detail |
query | boolean | False | No | Include detailed information about the allocated stock item. |
stock_item |
query | integer | No | ||
supplier_part_detail |
query | boolean | False | No | Include detailed information about the supplier part associated with this build item. |
tracked |
query | boolean | No | Tracked |
Responses
{
"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,
"install_into_detail": null,
"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,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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"
}
Responses
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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 |
Responses
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 |
Responses
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Stock Item"
},
"supplier_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier Part"
}
},
"type": "object"
}
Responses
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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"
}
Responses
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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"
},
"install_into_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"nullable": true,
"readOnly": true,
"title": "Install Into"
},
"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/StockItem"
}
],
"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/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 | |
allocations |
query | boolean | False | No | Include allocation details showing which stock items are allocated to this build line. |
assembly |
query | boolean | No | Assembly | |
assembly_detail |
query | boolean | False | No | Include brief details of the assembly (parent part) related to the BOM item in this build line. |
available |
query | boolean | No | Available | |
bom_item |
query | integer | No | ||
bom_item_detail |
query | boolean | False | No | Include detailed information about the BOM item linked to this build line. |
build |
query | integer | No | ||
build_detail |
query | boolean | False | No | Include detailed information about the associated build order. |
consumable |
query | boolean | No | Consumable | |
consumed |
query | boolean | No | Consumed | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
on_order |
query | boolean | No | On Order | |
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 | |
part_detail |
query | boolean | False | No | Include detailed information about the specific part being built or consumed in this build line. |
search |
query | string | No | A search term. Searched fields: bom_item__reference, bom_item__sub_part__IPN, bom_item__sub_part__description, bom_item__sub_part__name. | |
testable |
query | boolean | No | Testable | |
tracked |
query | boolean | No | Tracked |
Responses
{
"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,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"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,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"build",
"build_reference",
"consumable",
"consumed",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"pk",
"quantity",
"reference",
"scheduled_to_build",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"build",
"build_reference",
"consumable",
"consumed",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"pk",
"quantity",
"reference",
"scheduled_to_build",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"build",
"build_reference",
"consumable",
"consumed",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"pk",
"quantity",
"reference",
"scheduled_to_build",
"testable",
"trackable"
],
"type": "object"
}
Responses
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the response body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"build",
"build_reference",
"consumable",
"consumed",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"pk",
"quantity",
"reference",
"scheduled_to_build",
"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 |
Responses
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" |
allocations |
query | boolean | False | No | Include allocation details showing which stock items are allocated to this build line. |
assembly_detail |
query | boolean | False | No | Include brief details of the assembly (parent part) related to the BOM item in this build line. |
bom_item_detail |
query | boolean | False | No | Include detailed information about the BOM item linked to this build line. |
build_detail |
query | boolean | False | No | Include detailed information about the associated build order. |
id |
path | integer | No | ||
part_detail |
query | boolean | False | No | Include detailed information about the specific part being built or consumed in this build line. |
Responses
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the response body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"build",
"build_reference",
"consumable",
"consumed",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"pk",
"quantity",
"reference",
"scheduled_to_build",
"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,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"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,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"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,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
Responses
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the response body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"build",
"build_reference",
"consumable",
"consumed",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"pk",
"quantity",
"reference",
"scheduled_to_build",
"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,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"build",
"build_reference",
"consumable",
"consumed",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"pk",
"quantity",
"reference",
"scheduled_to_build",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"build",
"build_reference",
"consumable",
"consumed",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"pk",
"quantity",
"reference",
"scheduled_to_build",
"testable",
"trackable"
],
"type": "object"
}
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the request body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"build",
"build_reference",
"consumable",
"consumed",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"pk",
"quantity",
"reference",
"scheduled_to_build",
"testable",
"trackable"
],
"type": "object"
}
Responses
{
"allocated": 10.12,
"allocations": [
{
"bom_reference": "string",
"build": 0,
"build_detail": null,
"build_line": 0,
"install_into": 0,
"install_into_detail": null,
"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,
"assembly_detail": null,
"available_stock": 10.12,
"available_substitute_stock": 10.12,
"available_variant_stock": 10.12,
"bom_item": 0,
"bom_item_detail": null,
"build": 0,
"build_detail": null,
"build_reference": "string",
"category_detail": null,
"consumable": true,
"consumed": 10.12,
"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",
"scheduled_to_build": 10.12,
"testable": true,
"trackable": true
}
Schema of the response body
{
"description": "Serializer for a BuildItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"allocations": {
"items": {
"$ref": "#/components/schemas/BuildItem"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"allow_variants": {
"readOnly": true,
"type": "boolean"
},
"assembly_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Assembly"
},
"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"
}
],
"nullable": true,
"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"
},
"category_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Category"
}
],
"nullable": true,
"readOnly": true,
"title": "Category"
},
"consumable": {
"readOnly": true,
"type": "boolean"
},
"consumed": {
"format": "double",
"type": "number"
},
"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"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"readOnly": true,
"type": "string"
},
"scheduled_to_build": {
"format": "double",
"readOnly": true,
"type": "number"
},
"testable": {
"readOnly": true,
"type": "boolean"
},
"trackable": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"allocated",
"allow_variants",
"available_stock",
"available_substitute_stock",
"available_variant_stock",
"bom_item",
"build",
"build_reference",
"consumable",
"consumed",
"external_stock",
"in_production",
"inherited",
"on_order",
"optional",
"part",
"pk",
"quantity",
"reference",
"scheduled_to_build",
"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" |
Responses
{
"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"
}
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 |
Responses
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 |
Responses
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 37,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 49,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 231,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 156,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 57,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 93,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 101,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 221,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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"
}
Responses
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 185,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 207,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 128,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 267,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 188,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 188,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 27,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 194,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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"
}
Responses
{
"barcode_hash": "string",
"batch": "string",
"completed": 0,
"completion_date": "2022-04-13",
"creation_date": "2022-04-13",
"destination": 0,
"external": true,
"issued_by": 0,
"issued_by_detail": null,
"level": 0,
"link": "string",
"notes": "string",
"overdue": true,
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 153,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parent": 0,
"part": 0,
"part_detail": null,
"part_name": "string",
"pk": 0,
"priority": 69,
"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"
},
"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"
},
"external": {
"description": "This build order is fulfilled externally",
"title": "External Build",
"type": "boolean"
},
"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"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parent": {
"description": "Build Order 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",
"format": "int64",
"maximum": 9223372036854775807,
"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": "Sales Order 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": "Serializer for allocating 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": "Serializer for allocating 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": "Serializer for allocating stock items against a build order.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildAllocationItem"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
Responses
{
"items": [
{
"build_line": 0,
"output": 0,
"quantity": "string",
"stock_item": 0
}
]
}
Schema of the response body
{
"description": "Serializer for allocating 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
Override the POST method to handle auto allocation task.
As this is offloaded to the background task, we return information about the background task which is performing the auto allocation operation.
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,
"item_type": null,
"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"
},
"item_type": {
"allOf": [
{
"$ref": "#/components/schemas/ItemTypeEnum"
}
],
"default": "untracked",
"description": "Select item type to auto-allocate\n\n* `all` - All Items\n* `untracked` - Untracked Items\n* `tracked` - Tracked Items"
},
"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,
"item_type": null,
"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"
},
"item_type": {
"allOf": [
{
"$ref": "#/components/schemas/ItemTypeEnum"
}
],
"default": "untracked",
"description": "Select item type to auto-allocate\n\n* `all` - All Items\n* `untracked` - Untracked Items\n* `tracked` - Tracked Items"
},
"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,
"item_type": null,
"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"
},
"item_type": {
"allOf": [
{
"$ref": "#/components/schemas/ItemTypeEnum"
}
],
"default": "untracked",
"description": "Select item type to auto-allocate\n\n* `all` - All Items\n* `untracked` - Untracked Items\n* `tracked` - Tracked Items"
},
"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"
}
Responses
{
"complete": true,
"exists": true,
"http_status": 0,
"pending": true,
"success": true,
"task_id": "string"
}
Schema of the response body
{
"description": "Serializer for a background task detail.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"exists": {
"readOnly": true,
"type": "boolean"
},
"http_status": {
"readOnly": true,
"type": "integer"
},
"pending": {
"readOnly": true,
"type": "boolean"
},
"success": {
"readOnly": true,
"type": "boolean"
},
"task_id": {
"readOnly": true,
"type": "string"
}
},
"required": [
"complete",
"exists",
"http_status",
"pending",
"success",
"task_id"
],
"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"
}
Responses
{
"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,
"quantity": "string"
}
],
"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/BuildOutputQuantity"
},
"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,
"quantity": "string"
}
],
"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/BuildOutputQuantity"
},
"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,
"quantity": "string"
}
],
"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/BuildOutputQuantity"
},
"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"
}
Responses
{
"accept_incomplete_allocation": true,
"location": 0,
"notes": "string",
"outputs": [
{
"output": 0,
"quantity": "string"
}
],
"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/BuildOutputQuantity"
},
"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}/consume/¶
Description
Override the POST method to handle consume task.
As this is offloaded to the background task, we return information about the background task which is performing the consume operation.
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_item": 0,
"quantity": "string"
}
],
"lines": [
{
"build_line": 0
}
],
"notes": "string"
}
Schema of the request body
{
"description": "Serializer for consuming allocations against a BuildOrder.\n\n- Consumes allocated stock items, increasing the 'consumed' field for each BuildLine.\n- Stock can be consumed by passing either a list of BuildItem objects, or a list of BuildLine objects.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildConsumeAllocation"
},
"type": "array"
},
"lines": {
"items": {
"$ref": "#/components/schemas/BuildConsumeLineItem"
},
"type": "array"
},
"notes": {
"description": "Optional notes for the stock consumption",
"type": "string"
}
},
"type": "object"
}
{
"items": [
{
"build_item": 0,
"quantity": "string"
}
],
"lines": [
{
"build_line": 0
}
],
"notes": "string"
}
Schema of the request body
{
"description": "Serializer for consuming allocations against a BuildOrder.\n\n- Consumes allocated stock items, increasing the 'consumed' field for each BuildLine.\n- Stock can be consumed by passing either a list of BuildItem objects, or a list of BuildLine objects.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildConsumeAllocation"
},
"type": "array"
},
"lines": {
"items": {
"$ref": "#/components/schemas/BuildConsumeLineItem"
},
"type": "array"
},
"notes": {
"description": "Optional notes for the stock consumption",
"type": "string"
}
},
"type": "object"
}
{
"items": [
{
"build_item": 0,
"quantity": "string"
}
],
"lines": [
{
"build_line": 0
}
],
"notes": "string"
}
Schema of the request body
{
"description": "Serializer for consuming allocations against a BuildOrder.\n\n- Consumes allocated stock items, increasing the 'consumed' field for each BuildLine.\n- Stock can be consumed by passing either a list of BuildItem objects, or a list of BuildLine objects.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BuildConsumeAllocation"
},
"type": "array"
},
"lines": {
"items": {
"$ref": "#/components/schemas/BuildConsumeLineItem"
},
"type": "array"
},
"notes": {
"description": "Optional notes for the stock consumption",
"type": "string"
}
},
"type": "object"
}
Responses
{
"complete": true,
"exists": true,
"http_status": 0,
"pending": true,
"success": true,
"task_id": "string"
}
Schema of the response body
{
"description": "Serializer for a background task detail.",
"properties": {
"complete": {
"readOnly": true,
"type": "boolean"
},
"exists": {
"readOnly": true,
"type": "boolean"
},
"http_status": {
"readOnly": true,
"type": "integer"
},
"pending": {
"readOnly": true,
"type": "boolean"
},
"success": {
"readOnly": true,
"type": "boolean"
},
"task_id": {
"readOnly": true,
"type": "string"
}
},
"required": [
"complete",
"exists",
"http_status",
"pending",
"success",
"task_id"
],
"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"
}
Responses
[
{
"MPN": "string",
"SKU": "string",
"allocated": 10.12,
"barcode_hash": "string",
"batch": "string",
"belongs_to": 0,
"build": 0,
"child_items": 0,
"consumed_by": 0,
"customer": 0,
"delete_on_deplete": true,
"expired": true,
"expiry_date": "2022-04-13",
"in_stock": true,
"installed_items": 0,
"is_building": true,
"link": "string",
"location": 0,
"location_detail": null,
"location_path": [
{}
],
"notes": "string",
"owner": 0,
"packaging": "string",
"parent": 0,
"part": 0,
"part_detail": null,
"pk": 0,
"purchase_order": 0,
"purchase_order_reference": "string",
"purchase_price": "string",
"purchase_price_currency": "string",
"quantity": 10.12,
"sales_order": 0,
"sales_order_reference": "string",
"serial": "string",
"serial_numbers": "string",
"stale": true,
"status": null,
"status_custom_key": 0,
"status_text": "string",
"stocktake_date": "2022-04-13",
"supplier_part": 0,
"supplier_part_detail": null,
"tags": [
"string"
],
"tests": [
{
"attachment": "string",
"date": "2022-04-13T15:42:05.901Z",
"finished_datetime": "2022-04-13T15:42:05.901Z",
"notes": "string",
"pk": 0,
"result": true,
"started_datetime": "2022-04-13T15:42:05.901Z",
"stock_item": 0,
"template": 0,
"template_detail": null,
"test_station": "string",
"user": 0,
"user_detail": null,
"value": "string"
}
],
"tracking_items": 0,
"updated": "2022-04-13T15:42:05.901Z",
"use_pack_size": true
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/StockItem"
},
"type": "array"
}
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"
}
Responses
{
"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"
}
Responses
{
"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 |
Responses
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 |
Responses
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"
}
Responses
{
"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"
}
Responses
{
"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
BlankEnum¶
Type:
BomItem¶
| Name | Type | Description |
|---|---|---|
allow_variants |
boolean | Stock items for variant parts can be used for this BOM item |
attrition |
number(double) | |
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 | |
category_detail |
||
consumable |
boolean | This BOM item is consumable (it is not tracked in build orders) |
external_stock |
number(double) | null | |
inherited |
boolean | This BOM item is inherited by BOMs for variant parts |
note |
string | BOM item notes |
on_order |
number(double) | null | |
optional |
boolean | This BOM item is optional |
part |
integer | Select the parent assembly |
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 | BOM item reference |
rounding_multiple |
number(double) | null | |
setup_quantity |
number(double) | |
sub_part |
integer | Select the component part |
sub_part_detail |
||
substitutes |
Array<BomItemSubstitute> | |
validated |
boolean | This BOM item has been validated |
BomItemSubstitute¶
| Name | Type | Description |
|---|---|---|
bom_item |
integer | Parent BOM item |
part |
integer | Substitute part |
part_detail |
||
pk |
integer |
Build¶
| Name | Type | Description |
|---|---|---|
barcode_hash |
string | |
batch |
string | null | Batch code for this build output |
completed |
integer | Number of stock items which have been completed |
completion_date |
string(date) | null | |
creation_date |
string(date) | |
destination |
integer | null | Select location where the completed items will be stored |
external |
boolean | This build order is fulfilled externally |
issued_by |
integer | null | User who issued this build order |
issued_by_detail |
||
level |
integer | |
link |
string(uri) | Link to external URL |
notes |
string | null | Markdown notes (optional) |
overdue |
boolean | |
parameters |
Array<Parameter> | |
parent |
integer | null | Build Order to which this build is allocated |
part |
integer | Select part to build |
part_detail |
||
part_name |
string | |
pk |
integer | |
priority |
integer(int64) | Priority of this build order |
project_code |
integer | null | Project code for this build order |
project_code_detail |
||
project_code_label |
string | null | |
quantity |
number(double) | |
reference |
string | |
responsible |
integer | null | User or group responsible for this build order |
responsible_detail |
||
sales_order |
integer | null | Sales Order to which this build is allocated |
start_date |
string(date) | null | Scheduled start date for this build order |
status |
Build status code * `10` - Pending * `20` - Production * `25` - On Hold * `30` - Cancelled * `40` - Complete | |
status_custom_key |
integer | null | Additional status information for this item * `10` - Pending * `20` - Production * `25` - On Hold * `30` - Cancelled * `40` - Complete Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call. |
status_text |
string | |
take_from |
integer | null | Select location to take stock from for this build (leave blank to take from any stock location) |
target_date |
string(date) | null | Target date for build completion. Build will be overdue after this date. |
title |
string | Brief description of the build (optional) |
BuildAllocation¶
| Name | Type | Description |
|---|---|---|
items |
Array<BuildAllocationItem> |
BuildAllocationItem¶
| Name | Type | Description |
|---|---|---|
build_line |
integer | |
output |
integer | null | |
quantity |
string(decimal) | |
stock_item |
integer |
BuildAutoAllocation¶
| Name | Type | Description |
|---|---|---|
exclude_location |
integer | null | Exclude stock items from this selected location |
interchangeable |
boolean | Stock items in multiple locations can be used interchangeably |
item_type |
Select item type to auto-allocate * `all` - All Items * `untracked` - Untracked Items * `tracked` - Tracked Items | |
location |
integer | null | Stock location where parts are to be sourced (leave blank to take from any location) |
optional_items |
boolean | Allocate optional BOM items to build order |
substitutes |
boolean | Allow allocation of substitute parts |
BuildCancel¶
| Name | Type | Description |
|---|---|---|
remove_allocated_stock |
boolean | Consume any stock which has already been allocated to this build |
remove_incomplete_outputs |
boolean | Delete any build outputs which have not been completed |
BuildComplete¶
| Name | Type | Description |
|---|---|---|
accept_incomplete |
boolean | Accept that the required number of build outputs have not been completed |
accept_overallocated |
How do you want to handle extra stock items assigned to the build order * `reject` - Not permitted * `accept` - Accept as consumed by this build order * `trim` - Deallocate before completing this build order | |
accept_unallocated |
boolean | Accept that stock items have not been fully allocated to this build order |
BuildConsume¶
| Name | Type | Description |
|---|---|---|
items |
Array<BuildConsumeAllocation> | |
lines |
Array<BuildConsumeLineItem> | |
notes |
string | Optional notes for the stock consumption |
BuildConsumeAllocation¶
| Name | Type | Description |
|---|---|---|
build_item |
integer | |
quantity |
string(decimal) |
BuildConsumeLineItem¶
| Name | Type | Description |
|---|---|---|
build_line |
integer |
BuildItem¶
| Name | Type | Description |
|---|---|---|
bom_reference |
string | |
build |
integer | |
build_detail |
||
build_line |
integer | null | |
install_into |
integer | null | Destination stock item |
install_into_detail |
||
location |
integer | |
location_detail |
||
part_detail |
||
pk |
integer | |
quantity |
number(double) | |
stock_item |
integer | Source stock item |
stock_item_detail |
||
supplier_part_detail |
BuildLine¶
| Name | Type | Description |
|---|---|---|
allocated |
number(double) | |
allocations |
Array<BuildItem> | |
allow_variants |
boolean | |
assembly_detail |
||
available_stock |
number(double) | |
available_substitute_stock |
number(double) | |
available_variant_stock |
number(double) | |
bom_item |
integer | |
bom_item_detail |
||
build |
integer | Build object |
build_detail |
||
build_reference |
string | |
category_detail |
||
consumable |
boolean | |
consumed |
number(double) | |
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 | |
scheduled_to_build |
number(double) | |
testable |
boolean | |
trackable |
boolean |
BuildOutput¶
| Name | Type | Description |
|---|---|---|
output |
integer |
BuildOutputComplete¶
| Name | Type | Description |
|---|---|---|
accept_incomplete_allocation |
boolean | Complete outputs if stock has not been fully allocated |
location |
integer | Location for completed build outputs |
notes |
string | |
outputs |
Array<BuildOutputQuantity> | |
status_custom_key |
integer | Stock item status code * `10` - OK * `50` - Attention needed * `55` - Damaged * `60` - Destroyed * `65` - Rejected * `70` - Lost * `75` - Quarantined * `85` - Returned Additional custom status keys may be retrieved from the 'stock_status_retrieve' call. |
BuildOutputCreate¶
| Name | Type | Description |
|---|---|---|
auto_allocate |
boolean | null | Automatically allocate required items with matching serial numbers |
batch_code |
string | Batch code for this build output |
location |
integer | null | Stock location for build output |
quantity |
string(decimal) | Enter quantity for build output |
serial_numbers |
string | Enter serial numbers for build outputs |
BuildOutputDelete¶
| Name | Type | Description |
|---|---|---|
outputs |
Array<BuildOutput> |
BuildOutputQuantity¶
| Name | Type | Description |
|---|---|---|
output |
integer | |
quantity |
string(decimal) | Enter quantity for build output |
BuildOutputScrap¶
| Name | Type | Description |
|---|---|---|
discard_allocations |
boolean | Discard any stock allocations for scrapped outputs |
location |
integer | Stock location for scrapped outputs |
notes |
string | Reason for scrapping build output(s) |
outputs |
Array<BuildOutputQuantity> |
BuildStatusEnum¶
Type: integer
BuildUnallocation¶
| Name | Type | Description |
|---|---|---|
build_line |
integer | null | |
output |
integer | null |
BulkRequest¶
| Name | Type | Description |
|---|---|---|
filters |
||
items |
Array<integer> |
Category¶
| Name | Type | Description |
|---|---|---|
default_keywords |
string | null | Default keywords for parts in this category |
default_location |
integer | null | Default location for parts in this category |
description |
string | Description (optional) |
icon |
string | null | Icon (optional) |
level |
integer | |
name |
string | Name |
parent |
integer | null | Parent part category |
parent_default_location |
integer | null | |
part_count |
integer | null | |
path |
Array<> | |
pathstring |
string | Path |
pk |
integer | |
starred |
boolean | Return True if the category is directly "starred" by the current user. |
structural |
boolean | Parts may not be directly assigned to a structural category, but may be assigned to child categories. |
subcategories |
integer | null |
CompanyBrief¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this company active? |
currency |
string | Default currency used for this company |
description |
string | Description of the company |
image |
string(uri) | |
name |
string | Company name |
pk |
integer | |
tax_id |
string | Company Tax ID |
thumbnail |
string |
GenericStateClass¶
| Name | Type | Description |
|---|---|---|
status_class |
string | |
values |
GenericStateValue¶
| Name | Type | Description |
|---|---|---|
color |
string | |
custom |
boolean | |
key |
integer | |
label |
string | |
logical_key |
string | |
name |
string |
ItemTypeEnum¶
Type: string
LocationBrief¶
| Name | Type | Description |
|---|---|---|
name |
string | Name |
pathstring |
string | Path |
pk |
integer |
ManufacturerPart¶
| Name | Type | Description |
|---|---|---|
barcode_hash |
string | Unique hash of barcode data |
description |
string | null | Manufacturer part description |
link |
string(uri) | null | URL for external manufacturer part link |
manufacturer |
integer | |
manufacturer_detail |
||
MPN |
string | null | Manufacturer Part Number |
notes |
string | null | Markdown notes (optional) |
parameters |
Array<Parameter> | |
part |
integer | Select part |
part_detail |
||
pk |
integer | |
pretty_name |
string | null | |
tags |
Array<string> |
ModelType054Enum¶
Type: string
NullEnum¶
Type:
Owner¶
| Name | Type | Description |
|---|---|---|
label |
string | |
name |
string | |
owner_id |
integer(int64) | null | |
owner_model |
string | |
pk |
integer |
PaginatedBuildItemList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<BuildItem> |
PaginatedBuildLineList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<BuildLine> |
PaginatedBuildList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<Build> |
Parameter¶
| Name | Type | Description |
|---|---|---|
data |
string | Parameter Value |
data_numeric |
number(double) | null | |
model_id |
integer(int64) | ID of the target model for this parameter |
model_type |
||
note |
string | Optional note field |
pk |
integer | |
template |
integer | Parameter template |
template_detail |
||
updated |
string(date-time) | null | Timestamp of last update |
updated_by |
integer | null | User who last updated this object |
updated_by_detail |
ParameterTemplate¶
| Name | Type | Description |
|---|---|---|
checkbox |
boolean | Is this parameter a checkbox? |
choices |
string | Valid choices for this parameter (comma-separated) |
description |
string | Parameter description |
enabled |
boolean | Is this parameter template enabled? |
model_type |
||
name |
string | Parameter Name |
pk |
integer | |
selectionlist |
integer | null | Selection list for this parameter |
units |
string | Physical units for this parameter |
PartBrief¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this part active? |
assembly |
boolean | Can this part be built from other parts? |
barcode_hash |
string | Unique hash of barcode data |
category_default_location |
integer | null | |
component |
boolean | Can this part be used to build other parts? |
default_expiry |
integer(int64) | Expiry time (in days) for stock items of this part |
default_location |
integer | null | Where is this item normally stored? |
description |
string | Part description (optional) |
full_name |
string | Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings. |
image |
string(uri) | null | |
IPN |
string | null | Internal Part Number |
is_template |
boolean | Is this part a template part? |
locked |
boolean | Locked parts cannot be edited |
minimum_stock |
string(decimal) | Minimum allowed stock level |
name |
string | Part name |
pk |
integer | |
pricing_max |
string(decimal) | null | |
pricing_min |
string(decimal) | null | |
purchaseable |
boolean | Can this part be purchased from external suppliers? |
revision |
string | null | |
salable |
boolean | Can this part be sold to customers? |
testable |
boolean | Can this part have test results recorded against it? |
thumbnail |
string | |
trackable |
boolean | Does this part have tracking for unique items? |
units |
string | null | Units of measure for this part |
virtual |
boolean | Is this a virtual part, such as a software product or license? |
PartTestTemplate¶
| Name | Type | Description |
|---|---|---|
choices |
string | Valid choices for this test (comma-separated) |
description |
string | null | Enter description for this test |
enabled |
boolean | Is this test enabled? |
key |
string | |
part |
integer | |
pk |
integer | |
required |
boolean | Is this test required to pass? |
requires_attachment |
boolean | Does this test require a file attachment when adding a test result? |
requires_value |
boolean | Does this test require a value when adding a test result? |
results |
integer | Number of results recorded against this template |
test_name |
string | Enter a name for the test |
PatchedBuild¶
| Name | Type | Description |
|---|---|---|
barcode_hash |
string | |
batch |
string | null | Batch code for this build output |
completed |
integer | Number of stock items which have been completed |
completion_date |
string(date) | null | |
creation_date |
string(date) | |
destination |
integer | null | Select location where the completed items will be stored |
external |
boolean | This build order is fulfilled externally |
issued_by |
integer | null | User who issued this build order |
issued_by_detail |
||
level |
integer | |
link |
string(uri) | Link to external URL |
notes |
string | null | Markdown notes (optional) |
overdue |
boolean | |
parameters |
Array<Parameter> | |
parent |
integer | null | Build Order to which this build is allocated |
part |
integer | Select part to build |
part_detail |
||
part_name |
string | |
pk |
integer | |
priority |
integer(int64) | Priority of this build order |
project_code |
integer | null | Project code for this build order |
project_code_detail |
||
project_code_label |
string | null | |
quantity |
number(double) | |
reference |
string | |
responsible |
integer | null | User or group responsible for this build order |
responsible_detail |
||
sales_order |
integer | null | Sales Order to which this build is allocated |
start_date |
string(date) | null | Scheduled start date for this build order |
status |
Build status code * `10` - Pending * `20` - Production * `25` - On Hold * `30` - Cancelled * `40` - Complete | |
status_custom_key |
integer | null | Additional status information for this item * `10` - Pending * `20` - Production * `25` - On Hold * `30` - Cancelled * `40` - Complete Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call. |
status_text |
string | |
take_from |
integer | null | Select location to take stock from for this build (leave blank to take from any stock location) |
target_date |
string(date) | null | Target date for build completion. Build will be overdue after this date. |
title |
string | Brief description of the build (optional) |
PatchedBuildItem¶
| Name | Type | Description |
|---|---|---|
bom_reference |
string | |
build |
integer | |
build_detail |
||
build_line |
integer | null | |
install_into |
integer | null | Destination stock item |
install_into_detail |
||
location |
integer | |
location_detail |
||
part_detail |
||
pk |
integer | |
quantity |
number(double) | |
stock_item |
integer | Source stock item |
stock_item_detail |
||
supplier_part_detail |
PatchedBuildLine¶
| Name | Type | Description |
|---|---|---|
allocated |
number(double) | |
allocations |
Array<BuildItem> | |
allow_variants |
boolean | |
assembly_detail |
||
available_stock |
number(double) | |
available_substitute_stock |
number(double) | |
available_variant_stock |
number(double) | |
bom_item |
integer | |
bom_item_detail |
||
build |
integer | Build object |
build_detail |
||
build_reference |
string | |
category_detail |
||
consumable |
boolean | |
consumed |
number(double) | |
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 | |
scheduled_to_build |
number(double) | |
testable |
boolean | |
trackable |
boolean |
ProjectCode¶
| Name | Type | Description |
|---|---|---|
code |
string | Unique project code |
description |
string | Project description |
pk |
integer | |
responsible |
integer | null | User or group responsible for this project |
responsible_detail |
StockItem¶
| Name | Type | Description |
|---|---|---|
allocated |
number(double) | null | |
barcode_hash |
string | Unique hash of barcode data |
batch |
string | null | Batch code for this stock item |
belongs_to |
integer | null | Is this item installed in another item? |
build |
integer | null | Build for this stock item |
child_items |
integer | null | |
consumed_by |
integer | null | Build order which consumed this stock item |
customer |
integer | null | Customer |
delete_on_deplete |
boolean | Delete this Stock Item when stock is depleted |
expired |
boolean | null | |
expiry_date |
string(date) | null | Expiry date for stock item. Stock will be considered expired after this date |
in_stock |
boolean | |
installed_items |
integer | null | |
is_building |
boolean | |
link |
string(uri) | Link to external URL |
location |
integer | null | Where is this stock item located? |
location_detail |
||
location_path |
Array<> | |
MPN |
string | null | |
notes |
string | null | Markdown notes (optional) |
owner |
integer | null | Select Owner |
packaging |
string | null | Packaging this stock item is stored in |
parent |
integer | null | Parent stock item |
part |
integer | Base Part |
part_detail |
||
pk |
integer | |
purchase_order |
integer | null | Purchase order for this stock item |
purchase_order_reference |
string | null | |
purchase_price |
string(decimal) | null | Purchase price of this stock item, per unit or pack |
purchase_price_currency |
string | Purchase currency of this stock item * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
quantity |
number(double) | |
sales_order |
integer | null | |
sales_order_reference |
string | null | |
serial |
string | null | Serial number for this item |
serial_numbers |
string | null | Enter serial numbers for new items |
SKU |
string | null | |
stale |
boolean | null | |
status |
||
status_custom_key |
integer | null | Additional status information for this item * `10` - OK * `50` - Attention needed * `55` - Damaged * `60` - Destroyed * `65` - Rejected * `70` - Lost * `75` - Quarantined * `85` - Returned Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call. |
status_text |
string | |
stocktake_date |
string(date) | null | |
supplier_part |
integer | null | Select a matching supplier part for this stock item |
supplier_part_detail |
||
tags |
Array<string> | |
tests |
Array<StockItemTestResult> | |
tracking_items |
integer | null | |
updated |
string(date-time) | null | Timestamp of last update |
use_pack_size |
boolean | null | Use pack size when adding: the quantity defined is the number of packs |
StockItemStatusEnum¶
Type: integer
StockItemTestResult¶
| Name | Type | Description |
|---|---|---|
attachment |
string(uri) | null | Test result attachment |
date |
string(date-time) | |
finished_datetime |
string(date-time) | null | The timestamp of the test finish |
notes |
string | Test notes |
pk |
integer | |
result |
boolean | Test result |
started_datetime |
string(date-time) | null | The timestamp of the test start |
stock_item |
integer | |
template |
integer | null | Template |
template_detail |
||
test_station |
string | The identifier of the test station where the test was performed |
user |
integer | null | |
user_detail |
||
value |
string | Test output value |
SupplierPart¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this supplier part active? |
availability_updated |
string(date-time) | null | Date of last update of availability data |
available |
number(double) | |
barcode_hash |
string | Unique hash of barcode data |
description |
string | null | Supplier part description |
in_stock |
number(double) | null | |
link |
string(uri) | null | URL for external supplier part link |
manufacturer_detail |
||
manufacturer_part |
integer | null | Select manufacturer part |
manufacturer_part_detail |
||
MPN |
string | null | |
note |
string | null | Notes |
notes |
string | null | Markdown notes (optional) |
on_order |
number(double) | null | |
pack_quantity |
string | Total quantity supplied in a single pack. Leave empty for single items. |
pack_quantity_native |
number(double) | |
packaging |
string | null | Part packaging |
parameters |
Array<Parameter> | |
part |
integer | Select part |
part_detail |
||
pk |
integer | |
pretty_name |
string | null | |
price_breaks |
Array<SupplierPriceBreakBrief> | |
primary |
boolean | Is this the primary supplier part for the linked Part? |
SKU |
string | Supplier stock keeping unit |
supplier |
integer | |
supplier_detail |
||
tags |
Array<string> | |
updated |
string(date-time) | null |
SupplierPriceBreakBrief¶
| Name | Type | Description |
|---|---|---|
part |
integer | |
pk |
integer | |
price |
string(decimal) | null | |
price_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
quantity |
number(double) | |
supplier |
integer | |
updated |
string(date-time) | null | Timestamp of last update |
TaskDetail¶
| Name | Type | Description |
|---|---|---|
complete |
boolean | |
exists |
boolean | |
http_status |
integer | |
pending |
boolean | |
success |
boolean | |
task_id |
string |
User¶
| Name | Type | Description |
|---|---|---|
email |
string(email) | Email address of the user |
first_name |
string | First name of the user |
last_name |
string | Last name of the user |
pk |
integer | |
username |
string | Username |
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": "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.AuthenticatedByPassword¶
Authenticated by password.
{
"summary": "Authenticated by password.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
}
],
"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.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": "Magic 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": 404
}
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.PhoneNumbers¶
List of phone numbers.
Schema of the response body
null
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.ProviderSignup¶
Information relating to the pending provider signup.
{
"data": {
"account": null,
"email": [
null
],
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"account": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"email": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"required": [
"email",
"account",
"user"
],
"type": "object"
},
"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": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
Schema of the response body
null
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.RefreshToken¶
A new access token (and optionally new refresh token).
{
"data": {
"access_token": null,
"refresh_token": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"access_token": {
"$ref": "#/components/schemas/allauth.AccessToken"
},
"refresh_token": {
"$ref": "#/components/schemas/allauth.RefreshToken"
}
},
"required": [
"access_token"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"data",
"status"
],
"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,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.TOTPAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.",
"type": "boolean"
}
},
"type": "object"
},
"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": 404
}
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.TooManyRequests¶
Too many requests.
{
"status": 429
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
429
],
"type": "integer"
}
},
"required": [
"status"
],
"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.PasswordLess¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
passwordless |
query | boolean | 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