3DIAX API Reference¶
Authentise’s 3DIAX is designed to make it easier for users to maintain a large database of model data in the cloud. It is also an entryway into Authentise’s other services. The specification for the various endpoints are designed to be open so that other providers could create a service that adheres to the same specification and interoperate with any service that works with Authentise.
There are a few concepts involved with the Model service. This is the service for storing and manipulating models. It’s designed to be a location where users can dump any number of models and keep them stored indefinitely. From this service users can also slice and print models.
/about/
Get information about the service like the current version. Useful for testing the service is 'up'
Get service metadata
Schema (application/json)
Property | Type | Description |
---|---|---|
deployment_date | string |
The current deployment_date of the service in a free format. Example: '"2020-06-03"'
|
name | string |
The name of the project |
version | string |
The current version of the service Example: '"1.4"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/access-info-for-resource/
This API Endpoint lists what access right are allowed on Manufacturing Execution (MES) Resources.
This endpoint is used with custom-group to handle qualifications for editing/reworking specific work. This implementation is a little bit more complicated rather than check edit_group of related resource, it's also based on BureauRight and LocationRight to check access for whole resource group as well. For more details please look into platform level of this resource.
This is a report/summary endpoint, use only LIST behavior to share to UI what is allowed in the backend. HTTPS calls to GET/PUT/POST/PATCH/DELETE are blocked, since they do not make sense for this resource.
GET is not supported because we don't have "access info" resource in db.
Return info about access rights for next resources: - printer-type, - printer, - post_processor_type, - post_processor, - workflow, - run, - piece
Filter target_uri
is required for this API.
Schema (application/json)
Property | Type | Description |
---|---|---|
actions | array |
none available Example: ('[{"type": '
'"edit|delete|use|redo|remanufacture|change_workflow|flag_non_conformance", '
'"disallow_by_edit_groups": ["..."]}]')
|
target_uri | URL |
Related/target resource URI. Now it is supporting next resources: run, printer, printer-type, post-processor, post-processor-type, workflow, piece. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
actions | array |
none available Required Example: ('[{"type": '
'"edit|delete|use|redo|remanufacture|change_workflow|flag_non_conformance", '
'"disallow_by_edit_groups": ["..."]}]')
|
target_uri | URL |
Related/target resource URI. Now it is supporting next resources: run, printer, printer-type, post-processor, post-processor-type, workflow, piece. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This API Endpoint lists what access right are allowed on Manufacturing Execution (MES) Resources.
This endpoint is used with custom-group to handle qualifications for editing/reworking specific work. This implementation is a little bit more complicated rather than check edit_group of related resource, it's also based on BureauRight and LocationRight to check access for whole resource group as well. For more details please look into platform level of this resource.
This is a report/summary endpoint, use only LIST behavior to share to UI what is allowed in the backend. HTTPS calls to GET/PUT/POST/PATCH/DELETE are blocked, since they do not make sense for this resource.
GET is not supported because we don't have "access info" resource in db.
Schema (application/json)
Property | Type | Description |
---|---|---|
actions | array |
none available Example: ('[{"type": '
'"edit|delete|use|redo|remanufacture|change_workflow|flag_non_conformance", '
'"disallow_by_edit_groups": ["..."]}]')
|
target_uri | URL |
Related/target resource URI. Now it is supporting next resources: run, printer, printer-type, post-processor, post-processor-type, workflow, piece. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/anatomical-model-assembly/
Anatomical Model Assembly is child for Anatomic Model resource And parent for "Anatomical Model Part"
Requires "Anatomical Model" feature (anatomical-model)
Schema (application/json)
Property | Type | Description |
---|---|---|
anatomical_model | URI |
The URI of anatomical model which this assembly ties to |
assembly_type | string |
Assembly type of this resource. Choices
'"none|glued|magnet"'
|
created | iso-8601 datetime |
Datetime when assembly was created (in UTC). |
name | string |
Anatomical model name |
parts_quantity | integer |
Quantity of all parts of assembly |
printing_tech | string |
Printing Tech |
updated | iso-8601 datetime |
Datetime when assembly was updated last time (in UTC). |
uri | URI |
The URI of the assembly. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested assembly cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
anatomical_model | URI |
The URI of anatomical model which this assembly ties to Required |
assembly_type | string |
Assembly type of this resource. Required Choices
'"none|glued|magnet"'
|
created | iso-8601 datetime |
Datetime when assembly was created (in UTC). Required |
name | string |
Anatomical model name Required |
parts_quantity | integer |
Quantity of all parts of assembly Required |
printing_tech | string |
Printing Tech Required |
updated | iso-8601 datetime |
Datetime when assembly was updated last time (in UTC). Required |
uri | URI |
The URI of the assembly. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested assembly cannot be found. |
405 |
|
Anatomical Model Assembly is child for Anatomic Model resource And parent for "Anatomical Model Part"
Requires "Anatomical Model" feature (anatomical-model)
Schema (application/json)
Property | Type | Description |
---|---|---|
anatomical_model | URI |
The URI of anatomical model which this assembly ties to |
assembly_type | string |
Assembly type of this resource. Choices
'"none|glued|magnet"'
|
created | iso-8601 datetime |
Datetime when assembly was created (in UTC). |
name | string |
Anatomical model name |
parts_quantity | integer |
Quantity of all parts of assembly |
printing_tech | string |
Printing Tech |
updated | iso-8601 datetime |
Datetime when assembly was updated last time (in UTC). |
uri | URI |
The URI of the assembly. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested assembly cannot be found. |
405 |
|
/anatomical-model-part/
Anatomical Model Part is child for Anatomic Model Assembly resource. This resource includes model which can be represented by part. When model is processed, all model-related fields will be automatically filled.
Requires "Anatomical Model" feature (anatomical-model)
Schema (application/json)
Property | Type | Description |
---|---|---|
anatomical_model_assembly | URI |
The URI of anatomical model assembly which this part ties to |
assembly_type | string |
Assembly type of this resource. Choices
'"none|glued|magnet"'
|
color | string |
STL color, Any valid color in hex format (“#RRGGBB) |
color_opacity | float |
Color opacity, in float, [0, 1.0]. 0.0 is fully transparent. |
created | iso-8601 datetime |
Datetime when part was created (in UTC). |
download_location | string |
Download uri for model part |
file_name | string |
STL file name. None if not file processed yet. |
file_size | integer |
STL file size in bytes. None if not file processed yet. |
finish | string |
Surface finish, values are validated by frontend |
flexibility | integer |
Shore value, values are validated by frontend |
hollow_shells | float |
Goal thickness of surface shell in mm. null when solid_infill=True. Range 0.3 and 7.14 (mm) otherwise |
material | string |
Name of material used to print part, values are validated by frontend |
name | string |
File name of model, entered by user |
notes | string |
System notes for model part. Usually are used to store error of model |
printer_anatomy_element | string |
Printer anatomy element of family, values are validated by frontend |
printer_anatomy_family | string |
Printer anatomy family, values are validated by frontend |
printer_anatomy_properties | string |
Printer anatomy properties of element |
rotation_x | float |
Printing rotation in x axis, 0 to 360 |
rotation_y | float |
Printing rotation in y axis, 0 to 360 |
rotation_z | float |
Printing rotation in z axis, 0 to 360 |
snapshot_location | string |
Model snapshot/picture download link. |
solid_infill | boolean |
Whether the STL is solid or hollow and if it is hollow |
status | string |
Status of part / STL file loading Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
to_be_printed | boolean |
Is the STL to be printed or is it reference data |
updated | iso-8601 datetime |
Datetime when part was updated last time (in UTC). |
uri | URI |
The URI of the part. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Something constraints are invalid, so this part can't be processed. |
404 |
The requested part cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
anatomical_model_assembly | URI |
The URI of anatomical model assembly which this part ties to Required |
assembly_type | string |
Assembly type of this resource. Required Choices
'"none|glued|magnet"'
|
color | string |
STL color, Any valid color in hex format (“#RRGGBB) Required |
color_opacity | float |
Color opacity, in float, [0, 1.0]. 0.0 is fully transparent. Default: 1.0 |
created | iso-8601 datetime |
Datetime when part was created (in UTC). Required |
download_location | string |
Download uri for model part Required |
file_name | string |
STL file name. None if not file processed yet. Required |
file_size | integer |
STL file size in bytes. None if not file processed yet. Required |
finish | string |
Surface finish, values are validated by frontend Required |
flexibility | integer |
Shore value, values are validated by frontend Required |
hollow_shells | float |
Goal thickness of surface shell in mm. null when solid_infill=True. Range 0.3 and 7.14 (mm) otherwise Default: 0 |
material | string |
Name of material used to print part, values are validated by frontend Required |
name | string |
File name of model, entered by user Required |
notes | string |
System notes for model part. Usually are used to store error of model Required |
printer_anatomy_element | string |
Printer anatomy element of family, values are validated by frontend Required |
printer_anatomy_family | string |
Printer anatomy family, values are validated by frontend Required |
printer_anatomy_properties | string |
Printer anatomy properties of element Required |
rotation_x | float |
Printing rotation in x axis, 0 to 360 Required |
rotation_y | float |
Printing rotation in y axis, 0 to 360 Required |
rotation_z | float |
Printing rotation in z axis, 0 to 360 Required |
snapshot_location | string |
Model snapshot/picture download link. Required |
solid_infill | boolean |
Whether the STL is solid or hollow and if it is hollow Default: False |
status | string |
Status of part / STL file loading Required Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
to_be_printed | boolean |
Is the STL to be printed or is it reference data Default: False |
updated | iso-8601 datetime |
Datetime when part was updated last time (in UTC). Required |
uri | URI |
The URI of the part. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Something constraints are invalid, so this part can't be processed. |
404 |
The requested part cannot be found. |
405 |
|
Anatomical Model Part is child for Anatomic Model Assembly resource. This resource includes model which can be represented by part. When model is processed, all model-related fields will be automatically filled.
Requires "Anatomical Model" feature (anatomical-model)
Schema (application/json)
Property | Type | Description |
---|---|---|
anatomical_model_assembly | URI |
The URI of anatomical model assembly which this part ties to |
assembly_type | string |
Assembly type of this resource. Choices
'"none|glued|magnet"'
|
color | string |
STL color, Any valid color in hex format (“#RRGGBB) |
color_opacity | float |
Color opacity, in float, [0, 1.0]. 0.0 is fully transparent. |
created | iso-8601 datetime |
Datetime when part was created (in UTC). |
download_location | string |
Download uri for model part |
file_name | string |
STL file name. None if not file processed yet. |
file_size | integer |
STL file size in bytes. None if not file processed yet. |
finish | string |
Surface finish, values are validated by frontend |
flexibility | integer |
Shore value, values are validated by frontend |
hollow_shells | float |
Goal thickness of surface shell in mm. null when solid_infill=True. Range 0.3 and 7.14 (mm) otherwise |
material | string |
Name of material used to print part, values are validated by frontend |
name | string |
File name of model, entered by user |
notes | string |
System notes for model part. Usually are used to store error of model |
printer_anatomy_element | string |
Printer anatomy element of family, values are validated by frontend |
printer_anatomy_family | string |
Printer anatomy family, values are validated by frontend |
printer_anatomy_properties | string |
Printer anatomy properties of element |
rotation_x | float |
Printing rotation in x axis, 0 to 360 |
rotation_y | float |
Printing rotation in y axis, 0 to 360 |
rotation_z | float |
Printing rotation in z axis, 0 to 360 |
snapshot_location | string |
Model snapshot/picture download link. |
solid_infill | boolean |
Whether the STL is solid or hollow and if it is hollow |
status | string |
Status of part / STL file loading Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
to_be_printed | boolean |
Is the STL to be printed or is it reference data |
updated | iso-8601 datetime |
Datetime when part was updated last time (in UTC). |
uri | URI |
The URI of the part. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Something constraints are invalid, so this part can't be processed. |
404 |
The requested part cannot be found. |
405 |
|
/anatomical-model/
AnatomicalModel is the main resource for Anatomic Model ZIP generator, a custom format for RICOH (feature is enabled only for them for now). Requires"Anatomical Model" feature (anatomical-model)
AnatomicalModel - Anatomical Model Assembly - Anatomical Model Part - Anatomical Model Part - Anatomical Model Assembly - ...
Schema (application/json)
Property | Type | Description |
---|---|---|
accession_number | string |
DICOM Accession Number, user entered. |
assemblies_quantity | integer |
Quantity of all assemblies of anatomical model. |
build_file | string |
Download uri for anatomical model build file |
build_file_status | string |
Status of anatomical model file Choices
'"pending|processing|complete|error"'
|
case_id | string |
Case ID. |
created | iso-8601 datetime |
Datetime when anatomical model was created (in UTC). |
date_sent | iso-8601 datetime |
Time of package creation. User entered in the UI. |
description | string |
Anatomical model description. |
format_version | string |
Internal version of this file version/data format. |
medical_record_number | string |
Medical record number, determined by EMR system. |
name | string |
Anatomical model name |
notes | string |
System notes for anatomical model. Usually are used to store error for model |
parts_quantity | integer |
Quantity of all parts of all assemblies of anatomical model |
recreate_build_file | boolean |
Must be set to true when file must be regenerated |
scale_to_print | integer |
Printing scale in percentage, any integer between 1 and 200. 100 is actual size. |
updated | iso-8601 datetime |
Datetime when anatomical model was updated last time (in UTC). |
uri | URI |
The URI of the anatomical model. |
version | integer |
Package version, AKA the revision of this anatomical model. User entered in the UI. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested anatomical model cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
accession_number | string |
DICOM Accession Number, user entered. Required |
assemblies_quantity | integer |
Quantity of all assemblies of anatomical model. Required |
build_file | string |
Download uri for anatomical model build file Required |
build_file_status | string |
Status of anatomical model file Required Choices
'"pending|processing|complete|error"'
|
case_id | string |
Case ID. Required |
created | iso-8601 datetime |
Datetime when anatomical model was created (in UTC). Required |
date_sent | iso-8601 datetime |
Time of package creation. User entered in the UI. Required |
description | string |
Anatomical model description. Required |
format_version | string |
Internal version of this file version/data format. Required |
medical_record_number | string |
Medical record number, determined by EMR system. Required |
name | string |
Anatomical model name Required |
notes | string |
System notes for anatomical model. Usually are used to store error for model Required |
parts_quantity | integer |
Quantity of all parts of all assemblies of anatomical model Required |
recreate_build_file | boolean |
Must be set to true when file must be regenerated Default: False |
scale_to_print | integer |
Printing scale in percentage, any integer between 1 and 200. 100 is actual size. Default: 100 |
updated | iso-8601 datetime |
Datetime when anatomical model was updated last time (in UTC). Required |
uri | URI |
The URI of the anatomical model. Required |
version | integer |
Package version, AKA the revision of this anatomical model. User entered in the UI. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested anatomical model cannot be found. |
405 |
|
AnatomicalModel is the main resource for Anatomic Model ZIP generator, a custom format for RICOH (feature is enabled only for them for now). Requires"Anatomical Model" feature (anatomical-model)
AnatomicalModel - Anatomical Model Assembly - Anatomical Model Part - Anatomical Model Part - Anatomical Model Assembly - ...
Schema (application/json)
Property | Type | Description |
---|---|---|
accession_number | string |
DICOM Accession Number, user entered. |
assemblies_quantity | integer |
Quantity of all assemblies of anatomical model. |
build_file | string |
Download uri for anatomical model build file |
build_file_status | string |
Status of anatomical model file Choices
'"pending|processing|complete|error"'
|
case_id | string |
Case ID. |
created | iso-8601 datetime |
Datetime when anatomical model was created (in UTC). |
date_sent | iso-8601 datetime |
Time of package creation. User entered in the UI. |
description | string |
Anatomical model description. |
format_version | string |
Internal version of this file version/data format. |
medical_record_number | string |
Medical record number, determined by EMR system. |
name | string |
Anatomical model name |
notes | string |
System notes for anatomical model. Usually are used to store error for model |
parts_quantity | integer |
Quantity of all parts of all assemblies of anatomical model |
recreate_build_file | boolean |
Must be set to true when file must be regenerated |
scale_to_print | integer |
Printing scale in percentage, any integer between 1 and 200. 100 is actual size. |
updated | iso-8601 datetime |
Datetime when anatomical model was updated last time (in UTC). |
uri | URI |
The URI of the anatomical model. |
version | integer |
Package version, AKA the revision of this anatomical model. User entered in the UI. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested anatomical model cannot be found. |
405 |
|
/api_tokens/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
name | string |
none available Required |
secret | string |
none available Default: None |
user_uuid | uuid |
none available Default: None |
uuid | uuid |
none available Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
name | string |
none available |
secret | string |
none available |
user_uuid | uuid |
none available |
uuid | uuid |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/asset-version/
This is the resource for handling specific versions of a Model. This provides the ability to see specifics on changes that have been applied to a model. That includes the model prior to the change and the model after the change.
Get a list of asset versions.
Schema (application/json)
Property | Type | Description |
---|---|---|
asset | URI |
Identifier for the Asset instance this Asset-Version is apply to |
created | iso-8601 datetime |
The date this Asset-Version was created. |
message | string |
The message describing the change between the original model and new model |
new_model | URI |
Identifier for the new model that will be replacing the original model |
original_model | URI |
Identifier for the original model |
uri | URI |
Identifier for Asset-Version |
user | URI |
Identifier for the user who created said Asset-Version. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Create a new asset version.
Schema (application/json)
Property | Type | Description |
---|---|---|
asset | URI |
Identifier for the Asset instance this Asset-Version is apply to Required |
created | iso-8601 datetime |
The date this Asset-Version was created. Default: None |
message | string |
The message describing the change between the original model and new model Required |
new_model | URI |
Identifier for the new model that will be replacing the original model Required |
original_model | URI |
Identifier for the original model Default: None |
uri | URI |
Identifier for Asset-Version Default: None |
user | URI |
Identifier for the user who created said Asset-Version. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is the resource for handling specific versions of a Model. This provides the ability to see specifics on changes that have been applied to a model. That includes the model prior to the change and the model after the change.
Get a single asset version by uuid.
Schema (application/json)
Property | Type | Description |
---|---|---|
asset | URI |
Identifier for the Asset instance this Asset-Version is apply to |
created | iso-8601 datetime |
The date this Asset-Version was created. |
message | string |
The message describing the change between the original model and new model |
new_model | URI |
Identifier for the new model that will be replacing the original model |
original_model | URI |
Identifier for the original model |
uri | URI |
Identifier for Asset-Version |
user | URI |
Identifier for the user who created said Asset-Version. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/asset/
This is the resource for managing a Model versions. This provides the ability to track changes that have been applied to a model.
Get a list of assets.
Schema (application/json)
Property | Type | Description |
---|---|---|
action | string |
none available Choices
'"mesh_heal_via_Authentise|processing_mesh_heal_via_Authentise"'
|
allowed_transformations | object |
none available Example: '{}'
|
analyses | object |
status of manifold and count of inverted surface triangles Example: '{}'
|
auto-align | boolean |
none available |
callback | object |
none available Example: '{}'
|
children | array |
none available Example: '["..."]'
|
content | string |
Download to raw model content. Data format matches 'type'. |
conversion_notes | string |
Notes for the conversion process. |
conversion_original_content | string |
Link to binary content of pre-conversion file, if exists |
conversion_original_filename | string |
Filename of source native file |
conversion_original_type | string |
Type of input native file to send to X-Upload and for conversion_original_content Choices
'"x_t|xt|sat|step|stp|igs|iges|sldprt|ipt|prt|catpart|jt|j_t|3dm|obj|iam|dae|pdf|png|tiff|tif"'
|
conversion_status | string |
Sub-Status of conversion process if status is conversion Choices
'"new|pending|downloading|repairing|processing|uploading|complete|complete-without-upload|failed"'
|
created | iso-8601 datetime |
none available |
description | string |
Description of the Asset |
design_file | URI |
If directly unpacked from a design file (1:1) the URI of that design_file. Otherwise null. |
file_size | integer |
none available |
file_unit | string |
The default unit of the model file (inch, mm). Set null to allow autodetect. Choices
'"in|mm|cm|m|feet"'
|
manufacturing_orientation | object |
Manufacturing XYZ rotations of the model associated to this line-item, set by the user to control the structural robustness of the line item during the additive manufacturing step - not to be confused with the final position (transformation) on the build plate, which is instead set by the packing system. Example: '{"status": "in_queue|in_progress|error|uploaded"}'
|
mfg_oriented_content | string |
Download the mfg-oriented model's content. Data format matches 'type'. |
model | URI |
Identifier for a model instance |
name | string |
Name of the model. Cannot exceed 255 characters. |
parents | array |
none available Example: '["..."]'
|
polygons | integer |
none available |
replaced_models | array |
List of model URIs of all models that were replaced from a line_item, leading to the current model. Sorted from most recently replaced model to the oldest replaced model. Note: we dont return this field in LIST response because it requires expensive db operations and data is not needed for LIST at the moment Example: '["..."]'
|
rights | array |
none available Example: '["all|download|print|transform|transform-external|view"]'
|
size | object |
We use mm internally and front-end logic converts to user_unit Example: '{}'
|
snapshot | string |
none available |
snapshot_content | string |
none available |
status | string |
none available Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
surface_area_mm | float |
The surface area is in mm as unit at API level, not in user_units. |
type | string |
Format of data we will post to X-Upload-Location. Choices
'"stl"'
|
updated | iso-8601 datetime |
none available |
upload-location | string |
none available |
uri | URI |
none available |
user_unit | string |
Model files can have their units (file_units) and users can also specify units to read this API data. Internal data is always in MM, this changes API presentation of data only. We strongly encourage using the default of mm. Choices
'"in|mm"'
|
user_uri | URI |
none available |
versions | array |
List of Asset-Versions tied to a particular Asset Example: '["..."]'
|
virus_scan | string |
State of the virus-scan on the file pushed to X-Upload-Location. Quarantined indicates a problem was detected. Choices
'"unscanned|passed|quarantined"'
|
volume_mm | float |
The volume is in mm as unit at API level, not in user_units. |
zverse_conversion | URI |
ZVerse conversion URI (if model conversion was delegated to the ZVerse service). |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
generated-exception-class raised |
Create a new asset.
Schema (application/json)
Property | Type | Description |
---|---|---|
action | string |
none available Default: None Choices
'"mesh_heal_via_Authentise|processing_mesh_heal_via_Authentise"'
|
allowed_transformations | object |
none available Default: {'resize': False, 'rotation': False} Example: '{}'
|
analyses | object |
status of manifold and count of inverted surface triangles Default: None Example: '{}'
|
auto-align | boolean |
none available Default: None |
callback | object |
none available Default: None Example: '{}'
|
children | array |
none available Default: [] Example: '["..."]'
|
content | string |
Download to raw model content. Data format matches 'type'. Default: None |
conversion_notes | string |
Notes for the conversion process. Required |
conversion_original_content | string |
Link to binary content of pre-conversion file, if exists Required |
conversion_original_filename | string |
Filename of source native file Default: None |
conversion_original_type | string |
Type of input native file to send to X-Upload and for conversion_original_content Default: None Choices
'"x_t|xt|sat|step|stp|igs|iges|sldprt|ipt|prt|catpart|jt|j_t|3dm|obj|iam|dae|pdf|png|tiff|tif"'
|
conversion_status | string |
Sub-Status of conversion process if status is conversion Required Choices
'"new|pending|downloading|repairing|processing|uploading|complete|complete-without-upload|failed"'
|
created | iso-8601 datetime |
none available Default: None |
description | string |
Description of the Asset Default: None |
design_file | URI |
If directly unpacked from a design file (1:1) the URI of that design_file. Otherwise null. Required |
file_size | integer |
none available Default: None |
file_unit | string |
The default unit of the model file (inch, mm). Set null to allow autodetect. Default: mm Choices
'"in|mm|cm|m|feet"'
|
manufacturing_orientation | object |
Manufacturing XYZ rotations of the model associated to this line-item, set by the user to control the structural robustness of the line item during the additive manufacturing step - not to be confused with the final position (transformation) on the build plate, which is instead set by the packing system. Default: None Example: '{"status": "in_queue|in_progress|error|uploaded"}'
|
mfg_oriented_content | string |
Download the mfg-oriented model's content. Data format matches 'type'. Default: None |
model | URI |
Identifier for a model instance Required |
name | string |
Name of the model. Cannot exceed 255 characters. Required |
parents | array |
none available Default: [] Example: '["..."]'
|
polygons | integer |
none available Default: None |
replaced_models | array |
List of model URIs of all models that were replaced from a line_item, leading to the current model. Sorted from most recently replaced model to the oldest replaced model. Note: we dont return this field in LIST response because it requires expensive db operations and data is not needed for LIST at the moment Default: [] Example: '["..."]'
|
rights | array |
none available Default: None Example: '["all|download|print|transform|transform-external|view"]'
|
size | object |
We use mm internally and front-end logic converts to user_unit Default: None Example: '{}'
|
snapshot | string |
none available Default: None |
snapshot_content | string |
none available Default: None |
status | string |
none available Default: None Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
surface_area_mm | float |
The surface area is in mm as unit at API level, not in user_units. Default: None |
type | string |
Format of data we will post to X-Upload-Location. Required Choices
'"stl"'
|
updated | iso-8601 datetime |
none available Default: None |
upload-location | string |
none available Default: None |
uri | URI |
none available Default: None |
user_unit | string |
Model files can have their units (file_units) and users can also specify units to read this API data. Internal data is always in MM, this changes API presentation of data only. We strongly encourage using the default of mm. Default: mm Choices
'"in|mm"'
|
user_uri | URI |
none available Default: None |
versions | array |
List of Asset-Versions tied to a particular Asset Default: None Example: '["..."]'
|
virus_scan | string |
State of the virus-scan on the file pushed to X-Upload-Location. Quarantined indicates a problem was detected. Default: unscanned Choices
'"unscanned|passed|quarantined"'
|
volume_mm | float |
The volume is in mm as unit at API level, not in user_units. Default: None |
zverse_conversion | URI |
ZVerse conversion URI (if model conversion was delegated to the ZVerse service). Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
generated-exception-class raised |
/asset/{uuid}/
This is the resource for managing a Model versions. This provides the ability to track changes that have been applied to a model.
Get a single asset by uuid.
Schema (application/json)
Property | Type | Description |
---|---|---|
action | string |
none available Choices
'"mesh_heal_via_Authentise|processing_mesh_heal_via_Authentise"'
|
allowed_transformations | object |
none available Example: '{}'
|
analyses | object |
status of manifold and count of inverted surface triangles Example: '{}'
|
auto-align | boolean |
none available |
callback | object |
none available Example: '{}'
|
children | array |
none available Example: '["..."]'
|
content | string |
Download to raw model content. Data format matches 'type'. |
conversion_notes | string |
Notes for the conversion process. |
conversion_original_content | string |
Link to binary content of pre-conversion file, if exists |
conversion_original_filename | string |
Filename of source native file |
conversion_original_type | string |
Type of input native file to send to X-Upload and for conversion_original_content Choices
'"x_t|xt|sat|step|stp|igs|iges|sldprt|ipt|prt|catpart|jt|j_t|3dm|obj|iam|dae|pdf|png|tiff|tif"'
|
conversion_status | string |
Sub-Status of conversion process if status is conversion Choices
'"new|pending|downloading|repairing|processing|uploading|complete|complete-without-upload|failed"'
|
created | iso-8601 datetime |
none available |
description | string |
Description of the Asset |
design_file | URI |
If directly unpacked from a design file (1:1) the URI of that design_file. Otherwise null. |
file_size | integer |
none available |
file_unit | string |
The default unit of the model file (inch, mm). Set null to allow autodetect. Choices
'"in|mm|cm|m|feet"'
|
manufacturing_orientation | object |
Manufacturing XYZ rotations of the model associated to this line-item, set by the user to control the structural robustness of the line item during the additive manufacturing step - not to be confused with the final position (transformation) on the build plate, which is instead set by the packing system. Example: '{"status": "in_queue|in_progress|error|uploaded"}'
|
mfg_oriented_content | string |
Download the mfg-oriented model's content. Data format matches 'type'. |
model | URI |
Identifier for a model instance |
name | string |
Name of the model. Cannot exceed 255 characters. |
parents | array |
none available Example: '["..."]'
|
polygons | integer |
none available |
replaced_models | array |
List of model URIs of all models that were replaced from a line_item, leading to the current model. Sorted from most recently replaced model to the oldest replaced model. Note: we dont return this field in LIST response because it requires expensive db operations and data is not needed for LIST at the moment Example: '["..."]'
|
rights | array |
none available Example: '["all|download|print|transform|transform-external|view"]'
|
size | object |
We use mm internally and front-end logic converts to user_unit Example: '{}'
|
snapshot | string |
none available |
snapshot_content | string |
none available |
status | string |
none available Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
surface_area_mm | float |
The surface area is in mm as unit at API level, not in user_units. |
type | string |
Format of data we will post to X-Upload-Location. Choices
'"stl"'
|
updated | iso-8601 datetime |
none available |
upload-location | string |
none available |
uri | URI |
none available |
user_unit | string |
Model files can have their units (file_units) and users can also specify units to read this API data. Internal data is always in MM, this changes API presentation of data only. We strongly encourage using the default of mm. Choices
'"in|mm"'
|
user_uri | URI |
none available |
versions | array |
List of Asset-Versions tied to a particular Asset Example: '["..."]'
|
virus_scan | string |
State of the virus-scan on the file pushed to X-Upload-Location. Quarantined indicates a problem was detected. Choices
'"unscanned|passed|quarantined"'
|
volume_mm | float |
The volume is in mm as unit at API level, not in user_units. |
zverse_conversion | URI |
ZVerse conversion URI (if model conversion was delegated to the ZVerse service). |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
generated-exception-class raised |
/assignment/
Representing assignment
- object, which allows for users to see their tasks (order owner,
user(s) responsible for preparation task record) for which they are responsible.
In fact, this is not an assignment as such (it does not contain the logic for each individual object on assignment event), it is an assignment log that shows the very fact of a some assignment.
This endpoint is read only, assignments will be completed when related record is done (for example, order status is set to be "completed").
Assignment can be for user, for public group (prep task group for prep task record assignment) and for all users (edge case for prep task record, when target group is not set)
CAN'T BE CREATED DIRECTLY, only via changes from related resource.
Supported related entities controlled by :class:nautilus.constant.AssignmentRelatedTableName
.
When related record is completed, then assignment is going to be completed as well. If assignment is revoked (order owner is changed to another one), then assignment entity is going to be deleted.
Schema (application/json)
Property | Type | Description |
---|---|---|
assignee_edit_group | URI |
A specific edit_group if this assignment is representing a preparation task record and a edit group infilled for related preparation task. |
assignee_user | URI |
A specific user for whom the task is assigned, for example, an owner order or assignee to comment action. |
created | iso-8601 datetime |
Datetime when assignment was created (in UTC). |
created_by | URI |
The user who created the related object to which this assignment was created. |
is_active | boolean |
Is current assignment active or completed.Note: if access is revoked, then user will not see this entity at all,so is_active is not applied to this case |
name | string |
Name built based on related object. |
related_object_status | string |
Status of the related object. |
related_table_name | string |
The resource (related table name), to which this assignment is attached, for example order, prep_task_record, etc. Choices
'"order|prep_task_record|comment_action|stock"'
|
related_uri | URL |
URI of the exact object that this assignment is related to. |
related_uuid | uuid |
The UUID of the resource (related table), to which this assignment is attached. |
uri | URI |
The URI of the assignment. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. Action not allowed by permissions. |
404 |
The requested assignment cannot be found. |
We don't allow to create assignments via rest, this is a summary of data from other related resources. Assignment will be created by tied related resource.
Schema (application/json)
Property | Type | Description |
---|---|---|
assignee_edit_group | URI |
A specific edit_group if this assignment is representing a preparation task record and a edit group infilled for related preparation task. Required |
assignee_user | URI |
A specific user for whom the task is assigned, for example, an owner order or assignee to comment action. Required |
created | iso-8601 datetime |
Datetime when assignment was created (in UTC). Required |
created_by | URI |
The user who created the related object to which this assignment was created. Required |
is_active | boolean |
Is current assignment active or completed.Note: if access is revoked, then user will not see this entity at all,so is_active is not applied to this case Required |
name | string |
Name built based on related object. Required |
related_object_status | string |
Status of the related object. Required |
related_table_name | string |
The resource (related table name), to which this assignment is attached, for example order, prep_task_record, etc. Required Choices
'"order|prep_task_record|comment_action|stock"'
|
related_uri | URL |
URI of the exact object that this assignment is related to. Required |
related_uuid | uuid |
The UUID of the resource (related table), to which this assignment is attached. Required |
uri | URI |
The URI of the assignment. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. Action not allowed by permissions. |
404 |
The requested assignment cannot be found. |
Representing assignment
- object, which allows for users to see their tasks (order owner,
user(s) responsible for preparation task record) for which they are responsible.
In fact, this is not an assignment as such (it does not contain the logic for each individual object on assignment event), it is an assignment log that shows the very fact of a some assignment.
This endpoint is read only, assignments will be completed when related record is done (for example, order status is set to be "completed").
Assignment can be for user, for public group (prep task group for prep task record assignment) and for all users (edge case for prep task record, when target group is not set)
CAN'T BE CREATED DIRECTLY, only via changes from related resource.
Supported related entities controlled by :class:nautilus.constant.AssignmentRelatedTableName
.
When related record is completed, then assignment is going to be completed as well. If assignment is revoked (order owner is changed to another one), then assignment entity is going to be deleted.
Schema (application/json)
Property | Type | Description |
---|---|---|
assignee_edit_group | URI |
A specific edit_group if this assignment is representing a preparation task record and a edit group infilled for related preparation task. |
assignee_user | URI |
A specific user for whom the task is assigned, for example, an owner order or assignee to comment action. |
created | iso-8601 datetime |
Datetime when assignment was created (in UTC). |
created_by | URI |
The user who created the related object to which this assignment was created. |
is_active | boolean |
Is current assignment active or completed.Note: if access is revoked, then user will not see this entity at all,so is_active is not applied to this case |
name | string |
Name built based on related object. |
related_object_status | string |
Status of the related object. |
related_table_name | string |
The resource (related table name), to which this assignment is attached, for example order, prep_task_record, etc. Choices
'"order|prep_task_record|comment_action|stock"'
|
related_uri | URL |
URI of the exact object that this assignment is related to. |
related_uuid | uuid |
The UUID of the resource (related table), to which this assignment is attached. |
uri | URI |
The URI of the assignment. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. Action not allowed by permissions. |
404 |
The requested assignment cannot be found. |
/build-file-library-produce/
This appears to schedule turning a 'BuildFile Library Entry' into a scheduled run in the system A) 'Reverse' makes Order, Products, Line-Item for the build-file , puts them directly into 'confirmed' status B) Creates and schedules runs and related resources,
Schema (application/json)
Property | Type | Description |
---|---|---|
build_file_library | URI |
A build_file_library item to clone and put into production. |
docs | string |
Read Only processing state/info data from the backend process that is putting this build_file_library item into production. |
notes | string |
Read Only System notes on any errors or warning on putting this into production. |
status | string |
status of *the conversion to order, product, runs, etc. See individual resources for their own status. Choices
'"pending|processing|complete|error"'
|
uri | URI |
URI of the log/ tracker for this action. Aka The Schedule Build File Library own URI. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
Action not allowed by permissions. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
build_file_library | URI |
A build_file_library item to clone and put into production. Required |
docs | string |
Read Only processing state/info data from the backend process that is putting this build_file_library item into production. Required |
notes | string |
Read Only System notes on any errors or warning on putting this into production. Required |
status | string |
status of *the conversion to order, product, runs, etc. See individual resources for their own status. Required Choices
'"pending|processing|complete|error"'
|
uri | URI |
URI of the log/ tracker for this action. Aka The Schedule Build File Library own URI. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
Action not allowed by permissions. |
405 |
|
This appears to schedule turning a 'BuildFile Library Entry' into a scheduled run in the system A) 'Reverse' makes Order, Products, Line-Item for the build-file , puts them directly into 'confirmed' status B) Creates and schedules runs and related resources,
Schema (application/json)
Property | Type | Description |
---|---|---|
build_file_library | URI |
A build_file_library item to clone and put into production. |
docs | string |
Read Only processing state/info data from the backend process that is putting this build_file_library item into production. |
notes | string |
Read Only System notes on any errors or warning on putting this into production. |
status | string |
status of *the conversion to order, product, runs, etc. See individual resources for their own status. Choices
'"pending|processing|complete|error"'
|
uri | URI |
URI of the log/ tracker for this action. Aka The Schedule Build File Library own URI. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
Action not allowed by permissions. |
405 |
|
/build-file-library/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
build_file_template | URI |
Build file this Certified Build was based on |
created | iso-8601 datetime |
The date when the Build File Library was created. |
layout_template | URI |
Piece / Model layout this was based on |
models | array |
list of all models in the template build Example: '["..."]'
|
name | string |
The Build File Library name. |
owner | URL |
The user or bureau that can edit (or view, for some bureaus) this item. |
pieces | array |
list of all pieces in the template build plate Example: '["..."]'
|
run_template | URI |
Run this Certified Build was based on. |
updated | iso-8601 datetime |
The date when the Build File Library was updated |
uri | URI |
The Build File Library URI. |
workflows | array |
list of workflows for each piece, matches order / ordinal of piece Example: '["..."]'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
build_file_template | URI |
Build file this Certified Build was based on Required |
created | iso-8601 datetime |
The date when the Build File Library was created. Default: None |
layout_template | URI |
Piece / Model layout this was based on Required |
models | array |
list of all models in the template build Required Example: '["..."]'
|
name | string |
The Build File Library name. Required |
owner | URL |
The user or bureau that can edit (or view, for some bureaus) this item. Required |
pieces | array |
list of all pieces in the template build plate Required Example: '["..."]'
|
run_template | URI |
Run this Certified Build was based on. Required |
updated | iso-8601 datetime |
The date when the Build File Library was updated Default: None |
uri | URI |
The Build File Library URI. Required |
workflows | array |
list of workflows for each piece, matches order / ordinal of piece Required Example: '["..."]'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
|
404 |
|
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
build_file_template | URI |
Build file this Certified Build was based on |
created | iso-8601 datetime |
The date when the Build File Library was created. |
layout_template | URI |
Piece / Model layout this was based on |
models | array |
list of all models in the template build Example: '["..."]'
|
name | string |
The Build File Library name. |
owner | URL |
The user or bureau that can edit (or view, for some bureaus) this item. |
pieces | array |
list of all pieces in the template build plate Example: '["..."]'
|
run_template | URI |
Run this Certified Build was based on. |
updated | iso-8601 datetime |
The date when the Build File Library was updated |
uri | URI |
The Build File Library URI. |
workflows | array |
list of workflows for each piece, matches order / ordinal of piece Example: '["..."]'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
/build-file/
This endpoint returns data for build-files. That means Files feed to manufacturing machines, to make them run and build something. Note, in 3D printing some 'Design' files are the same format as 'Machine Data' files, causing some confusion here. If it comes from this endpoint, it is suppose to be loaded into a machine.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The datetime when build file was marked as archived. |
content | string |
Download URI for the build file. Link is valid for 5 minutes by default. |
created | iso-8601 datetime |
The datetime when build file was created. |
file_size | integer |
The file size in bytes. |
file_unit | string |
Base units of the output file Choices
'"in|mm|cm|m|feet"'
|
format | string |
File format of this output build file. Choices
'"stl|3mf"'
|
layout | URI |
The URI of the run's layout. Only generated by the system build files can have layout (for now). |
name | string |
Suggested file - name for this build when downloaded. |
notes | string |
System or user notes on the layout or file generation |
printer_type | URI |
The URI of the printer type (infilled based on target printing run during creation). |
run | URI |
The run build_file is machine instructions for. Note the many:1 (build_file:run) behavior. |
snapshot_content | string |
Build file snapshot/picture download link. Link is valid for 5 minutes by default. |
status | string |
Status of a backend file processing job. Choices
'"pending|processing|complete|error"'
|
updated | iso-8601 datetime |
The datetime when build file was updated last time. |
upload_location | string |
Upload location for the build file. Link is valid for 5 minutes by default. |
uri | URI |
URI of the build file. |
user | URI |
User which uploaded build file. |
virus_scan | string |
Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected. Choices
'"unscanned|passed|quarantined"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
Modification of the comment allowed only for comment owner. |
404 |
The requested workflow cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The datetime when build file was marked as archived. Required |
content | string |
Download URI for the build file. Link is valid for 5 minutes by default. Required |
created | iso-8601 datetime |
The datetime when build file was created. Required |
file_size | integer |
The file size in bytes. Required |
file_unit | string |
Base units of the output file Required Choices
'"in|mm|cm|m|feet"'
|
format | string |
File format of this output build file. Required Choices
'"stl|3mf"'
|
layout | URI |
The URI of the run's layout. Only generated by the system build files can have layout (for now). Required |
name | string |
Suggested file - name for this build when downloaded. Required |
notes | string |
System or user notes on the layout or file generation Required |
printer_type | URI |
The URI of the printer type (infilled based on target printing run during creation). Required |
run | URI |
The run build_file is machine instructions for. Note the many:1 (build_file:run) behavior. Required |
snapshot_content | string |
Build file snapshot/picture download link. Link is valid for 5 minutes by default. Required |
status | string |
Status of a backend file processing job. Default: pending Choices
'"pending|processing|complete|error"'
|
updated | iso-8601 datetime |
The datetime when build file was updated last time. Required |
upload_location | string |
Upload location for the build file. Link is valid for 5 minutes by default. Required |
uri | URI |
URI of the build file. Required |
user | URI |
User which uploaded build file. Required |
virus_scan | string |
Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected. Default: unscanned Choices
'"unscanned|passed|quarantined"'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
Modification of the comment allowed only for comment owner. |
404 |
The requested workflow cannot be found. |
405 |
|
This endpoint returns data for build-files. That means Files feed to manufacturing machines, to make them run and build something. Note, in 3D printing some 'Design' files are the same format as 'Machine Data' files, causing some confusion here. If it comes from this endpoint, it is suppose to be loaded into a machine.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The datetime when build file was marked as archived. |
content | string |
Download URI for the build file. Link is valid for 5 minutes by default. |
created | iso-8601 datetime |
The datetime when build file was created. |
file_size | integer |
The file size in bytes. |
file_unit | string |
Base units of the output file Choices
'"in|mm|cm|m|feet"'
|
format | string |
File format of this output build file. Choices
'"stl|3mf"'
|
layout | URI |
The URI of the run's layout. Only generated by the system build files can have layout (for now). |
name | string |
Suggested file - name for this build when downloaded. |
notes | string |
System or user notes on the layout or file generation |
printer_type | URI |
The URI of the printer type (infilled based on target printing run during creation). |
run | URI |
The run build_file is machine instructions for. Note the many:1 (build_file:run) behavior. |
snapshot_content | string |
Build file snapshot/picture download link. Link is valid for 5 minutes by default. |
status | string |
Status of a backend file processing job. Choices
'"pending|processing|complete|error"'
|
updated | iso-8601 datetime |
The datetime when build file was updated last time. |
upload_location | string |
Upload location for the build file. Link is valid for 5 minutes by default. |
uri | URI |
URI of the build file. |
user | URI |
User which uploaded build file. |
virus_scan | string |
Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected. Choices
'"unscanned|passed|quarantined"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
Modification of the comment allowed only for comment owner. |
404 |
The requested workflow cannot be found. |
405 |
|
/build/
This endpoint allows you to get and set information about builds that have occurred from one of your 3D printers. A build is the process of doing a print run, regardless of the number of independent CAD models that were represented in the build volume.
List all of the builds in the system for your account. Can be filtered by start_time
and end_time
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the cassette resource was created |
current_layer | integer |
The current layer being manufactured in this build |
end_time | iso-8601 datetime |
The date and time the build ended, if available |
estimated_time | timedelta |
The estimated printing time. Default unit is seconds. |
layers | integer |
The number of layers in this build |
materials | array |
List of materials names and the amount being used. Example: '[{}]'
|
modeler | URI |
The URI of the printer performing the build |
name | string |
The name of the build as determined by the printer |
run | URI |
The URI of build's related run, if any. Build is linked to a run record while creating or updating a buildif the build's name equals the run uuid of some run record in the system.Note: This field not settable by POST/PUT; it is set in platform layer while internally creating a build from captures |
start_time | iso-8601 datetime |
The date and time the build started |
status | string |
The status of the build, such as 'in progress' Choices
'"complete|failed|machine_error|new|part_exceeds_boundaries|processing|suspended|user_abort|paused|preheat|waiting_for_resolution|error|cancelled|backlogged|unknown"'
|
updated | iso-8601 datetime |
When the cassette resource was updated |
uri | URI |
The URI for this build |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The build requested cannot be found |
Create a new build
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the cassette resource was created Default: None |
current_layer | integer |
The current layer being manufactured in this build Required |
end_time | iso-8601 datetime |
The date and time the build ended, if available Default: None |
estimated_time | timedelta |
The estimated printing time. Default unit is seconds. Default: None |
layers | integer |
The number of layers in this build Required |
materials | array |
List of materials names and the amount being used. Default: [] Example: '[{}]'
|
modeler | URI |
The URI of the printer performing the build Required |
name | string |
The name of the build as determined by the printer Required |
run | URI |
The URI of build's related run, if any. Build is linked to a run record while creating or updating a buildif the build's name equals the run uuid of some run record in the system.Note: This field not settable by POST/PUT; it is set in platform layer while internally creating a build from captures Default: None |
start_time | iso-8601 datetime |
The date and time the build started Required |
status | string |
The status of the build, such as 'in progress' Required Choices
'"complete|failed|machine_error|new|part_exceeds_boundaries|processing|suspended|user_abort|paused|preheat|waiting_for_resolution|error|cancelled|backlogged|unknown"'
|
updated | iso-8601 datetime |
When the cassette resource was updated Default: None |
uri | URI |
The URI for this build Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The build requested cannot be found |
/build/{uuid}/
This endpoint allows you to get and set information about builds that have occurred from one of your 3D printers. A build is the process of doing a print run, regardless of the number of independent CAD models that were represented in the build volume.
Get a single build by UUID
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the cassette resource was created |
current_layer | integer |
The current layer being manufactured in this build |
end_time | iso-8601 datetime |
The date and time the build ended, if available |
estimated_time | timedelta |
The estimated printing time. Default unit is seconds. |
layers | integer |
The number of layers in this build |
materials | array |
List of materials names and the amount being used. Example: '[{}]'
|
modeler | URI |
The URI of the printer performing the build |
name | string |
The name of the build as determined by the printer |
run | URI |
The URI of build's related run, if any. Build is linked to a run record while creating or updating a buildif the build's name equals the run uuid of some run record in the system.Note: This field not settable by POST/PUT; it is set in platform layer while internally creating a build from captures |
start_time | iso-8601 datetime |
The date and time the build started |
status | string |
The status of the build, such as 'in progress' Choices
'"complete|failed|machine_error|new|part_exceeds_boundaries|processing|suspended|user_abort|paused|preheat|waiting_for_resolution|error|cancelled|backlogged|unknown"'
|
updated | iso-8601 datetime |
When the cassette resource was updated |
uri | URI |
The URI for this build |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The build requested cannot be found |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Filtering settings only by bureau's uuid
.
Return only one instance (if find) wrapped in list.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau URI |
favicon | URI |
Link for favicon document of bureau. Null if it's not uploaded |
favicon_content | string |
The uploaded URL of the favicon |
logo | URI |
Link for logo document of bureau. Null if it's not uploaded |
logo_content | string |
The uploaded URL of the logo |
order_header_image | string |
Header image Choices
'"b|u|r|e|a|u"'
|
order_header_image_content | string |
The uploaded URL of the header image |
order_header_text | string |
Order Quote header text Choices
'"b|u|r|e|a|u"'
|
order_pretable_text | string |
Order Quote pre table text Choices
'"b|u|r|e|a|u"'
|
order_show_page_number | boolean |
Is pages number visible in Order Quote Choices
'"True|False"'
|
order_table_bg_color | string |
Order Quote table background color Choices
'"b|u|r|e|a|u"'
|
order_table_delivery_info | string |
The URI of bureau the branding belongs to. Choices
'"b|u|r|e|a|u"'
|
order_table_footer | string |
Order Quote table footer text Choices
'"b|u|r|e|a|u"'
|
order_table_header_bg_color | string |
Order Quote header background color Choices
'"b|u|r|e|a|u"'
|
order_table_header_color | string |
Order Quote header color Choices
'"b|u|r|e|a|u"'
|
order_table_post_table | string |
Order Quote table post table text Choices
'"b|u|r|e|a|u"'
|
order_table_row_bottom_color | string |
Order Quote border-bottom color for each row to main table Choices
'"b|u|r|e|a|u"'
|
order_table_show_column_borders | boolean |
Is column borders visible in Order Quote Choices
'"True|False"'
|
order_table_show_row_borders | boolean |
Is row borders visible in Order Quote Choices
'"True|False"'
|
uri | URI |
The bureau settings URI |
ux_style | string |
Bureau styling key. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Note: by default it applies filters be user bureau and add to it passed bureau_branding.uuid
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau URI |
favicon | URI |
Link for favicon document of bureau. Null if it's not uploaded |
favicon_content | string |
The uploaded URL of the favicon |
logo | URI |
Link for logo document of bureau. Null if it's not uploaded |
logo_content | string |
The uploaded URL of the logo |
order_header_image | string |
Header image Choices
'"b|u|r|e|a|u"'
|
order_header_image_content | string |
The uploaded URL of the header image |
order_header_text | string |
Order Quote header text Choices
'"b|u|r|e|a|u"'
|
order_pretable_text | string |
Order Quote pre table text Choices
'"b|u|r|e|a|u"'
|
order_show_page_number | boolean |
Is pages number visible in Order Quote Choices
'"True|False"'
|
order_table_bg_color | string |
Order Quote table background color Choices
'"b|u|r|e|a|u"'
|
order_table_delivery_info | string |
The URI of bureau the branding belongs to. Choices
'"b|u|r|e|a|u"'
|
order_table_footer | string |
Order Quote table footer text Choices
'"b|u|r|e|a|u"'
|
order_table_header_bg_color | string |
Order Quote header background color Choices
'"b|u|r|e|a|u"'
|
order_table_header_color | string |
Order Quote header color Choices
'"b|u|r|e|a|u"'
|
order_table_post_table | string |
Order Quote table post table text Choices
'"b|u|r|e|a|u"'
|
order_table_row_bottom_color | string |
Order Quote border-bottom color for each row to main table Choices
'"b|u|r|e|a|u"'
|
order_table_show_column_borders | boolean |
Is column borders visible in Order Quote Choices
'"True|False"'
|
order_table_show_row_borders | boolean |
Is row borders visible in Order Quote Choices
'"True|False"'
|
uri | URI |
The bureau settings URI |
ux_style | string |
Bureau styling key. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
This is bureau-wide settings related to order / line-item intake, customer price, and related information. Time / costs added here are for customer price.
List all the bureau intake settings in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the settings belongs to. |
default_labor_charge_per | float |
Default labor charge per hour for forecasts. In bureau_settings.currency units. Example units: $/hr |
default_labor_time | timedelta |
Total time in HH:MM a piece is going to occupy a laborer at a workstation in seconds |
default_machine_run_charge_per | float |
Default machine running-time charge per hour for forecasts. In bureau_settings.currency units. Example units: $/hr |
default_machine_run_time | timedelta |
Total time in HH:MM a piece is going to occupy a running machine (consuming power) at a workstation, in seconds |
default_workstation_charge_per | float |
Default workstation charge per hour for forecasts. In bureau_settings.currency units. Example units: $/hr |
default_workstation_time | timedelta |
Total time in HH:MM a piece is going to occupy the workstation for forecasts. Setup, running, cooldown / wait included. in seconds |
uri | URI |
The URI of if this specific bureau intake settings. Null if not set & using defaults |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
This is bureau-wide settings related to order / line-item intake, customer price, and related information. Time / costs added here are for customer price.
Get a single bureau intake settings by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the settings belongs to. |
default_labor_charge_per | float |
Default labor charge per hour for forecasts. In bureau_settings.currency units. Example units: $/hr |
default_labor_time | timedelta |
Total time in HH:MM a piece is going to occupy a laborer at a workstation in seconds |
default_machine_run_charge_per | float |
Default machine running-time charge per hour for forecasts. In bureau_settings.currency units. Example units: $/hr |
default_machine_run_time | timedelta |
Total time in HH:MM a piece is going to occupy a running machine (consuming power) at a workstation, in seconds |
default_workstation_charge_per | float |
Default workstation charge per hour for forecasts. In bureau_settings.currency units. Example units: $/hr |
default_workstation_time | timedelta |
Total time in HH:MM a piece is going to occupy the workstation for forecasts. Setup, running, cooldown / wait included. in seconds |
uri | URI |
The URI of if this specific bureau intake settings. Null if not set & using defaults |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
/bureau-notification/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
author_name | string |
The name of the notification's author. |
bureau | URI |
The URI of the bureau this applies to. |
created | iso-8601 datetime |
Datetime when notification was created (in UTC). |
text | string |
The text of the notification in markdown. |
uri | URI |
The URI of the bureau notification. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested sample cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
author_name | string |
The name of the notification's author. Required |
bureau | URI |
The URI of the bureau this applies to. Required |
created | iso-8601 datetime |
Datetime when notification was created (in UTC). Required |
text | string |
The text of the notification in markdown. Required |
uri | URI |
The URI of the bureau notification. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested sample cannot be found. |
405 |
|
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
author_name | string |
The name of the notification's author. |
bureau | URI |
The URI of the bureau this applies to. |
created | iso-8601 datetime |
Datetime when notification was created (in UTC). |
text | string |
The text of the notification in markdown. |
uri | URI |
The URI of the bureau notification. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested sample cannot be found. |
405 |
|
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Filtering settings only by bureau's uuid
.
Return only one instance (if find) wrapped in list.
Schema (application/json)
Property | Type | Description |
---|---|---|
autologout_after | integer |
User will be logged out after this many minutes of API inactivity. |
bureau | URI |
The URI of bureau the settings belongs to. |
contactless_logon_enabled | boolean |
none available Choices
'"True|False"'
|
contactless_logon_timeout | integer |
Number of minutes that it takes for a contactless logon to timeout |
default_currency | string |
Default currency (abbreviation) used by bureau. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
default_location | URI |
The location is automatically created in admin/create_bureau.py. The user would have the option to use this location while creating resources like Stock, Printers, etc. that need a location to exist. |
default_prep_workflow | URI |
The prep workflow that a line_item should default to using during creation.This field is used when prep-workflow feature is enabled. |
default_units | string |
The Unit of Measure for models (mm or in) Choices
'"in|mm"'
|
default_workflow | URI |
The workflow that a line_item should default to using during creation, when a workflow is not specified in the POST request payload |
force | boolean |
Skip the checks that must be made to ensure that no Bureau user has an active contactless logon Choices
'"True|False"'
|
hourly_design_cost | float |
Price per hour for design work. |
last_scheduled | iso-8601 datetime |
The end of the last recorded scheduling update for this bureau |
mes_base_format | string |
Main file type used for MES data operations. Order Entry may support different formats. Choices
'"stl|3mf"'
|
notification_custom_emails | array |
List of custom email addresses to which the notification should be sent. Example: '["..."]'
|
notification_guest_registered |
Email of a bureau manager which should receive email notifications when a new guest user was registered. |
|
notification_line_items_confirmed | integer |
Indicate who should receive a notification (order owner, customer, custom email) when all line items in the order are confirmed. Choices
'"0|1|2|3|4|5|6|7"'
|
notification_order_completed | integer |
Who should receive a notification (order owner, customer, custom email) when an order has been completed. Choices
'"0|1|2|3|4|5|6|7"'
|
notification_order_created | integer |
Who should receive a notification (order owner, customer, custom email) when an order is created. Choices
'"0|1|4|5"'
|
notification_order_owner | integer |
Who should receive a notification (order owner, customer, custom email) when order owner has been changed. Choices
'"0|1|2|3|4|5|6|7"'
|
notification_order_scheduled | integer |
Who should receive a notification (order owner, customer, custom email) when all objects in an order have been scheduled. Choices
'"0|1|2|3|4|5|6|7"'
|
notification_order_started_printing | integer |
Who should receive a notification (order owner, customer, custom email) when the first line item in an order starts printing. Choices
'"0|1|2|3|4|5|6|7"'
|
notification_print_error | integer |
Who should receive a notification (order owner, customer, custom email) when printing fails for any object in an order. Choices
'"0|1|2|3|4|5|6|7"'
|
order_quote_notes_placeholder | string |
Default text for the Order Quote notes section for all bureau orders. |
save_user_rotation | string |
Specify what happens when 3D renderer is exited after making a transformation to the model. Choices
'"never|always|ask_each_time"'
|
scheduling_frequency | integer |
The minimum number of minutes between the end of one scheduling update and the start of another for this same bureau |
uri | URI |
The bureau settings URI. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Note: by default it applies filters be user bureau and add to it passed bureau_settings.uuid
Schema (application/json)
Property | Type | Description |
---|---|---|
autologout_after | integer |
User will be logged out after this many minutes of API inactivity. |
bureau | URI |
The URI of bureau the settings belongs to. |
contactless_logon_enabled | boolean |
none available Choices
'"True|False"'
|
contactless_logon_timeout | integer |
Number of minutes that it takes for a contactless logon to timeout |
default_currency | string |
Default currency (abbreviation) used by bureau. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
default_location | URI |
The location is automatically created in admin/create_bureau.py. The user would have the option to use this location while creating resources like Stock, Printers, etc. that need a location to exist. |
default_prep_workflow | URI |
The prep workflow that a line_item should default to using during creation.This field is used when prep-workflow feature is enabled. |
default_units | string |
The Unit of Measure for models (mm or in) Choices
'"in|mm"'
|
default_workflow | URI |
The workflow that a line_item should default to using during creation, when a workflow is not specified in the POST request payload |
force | boolean |
Skip the checks that must be made to ensure that no Bureau user has an active contactless logon Choices
'"True|False"'
|
hourly_design_cost | float |
Price per hour for design work. |
last_scheduled | iso-8601 datetime |
The end of the last recorded scheduling update for this bureau |
mes_base_format | string |
Main file type used for MES data operations. Order Entry may support different formats. Choices
'"stl|3mf"'
|
notification_custom_emails | array |
List of custom email addresses to which the notification should be sent. Example: '["..."]'
|
notification_guest_registered |
Email of a bureau manager which should receive email notifications when a new guest user was registered. |
|
notification_line_items_confirmed | integer |
Indicate who should receive a notification (order owner, customer, custom email) when all line items in the order are confirmed. Choices
'"0|1|2|3|4|5|6|7"'
|
notification_order_completed | integer |
Who should receive a notification (order owner, customer, custom email) when an order has been completed. Choices
'"0|1|2|3|4|5|6|7"'
|
notification_order_created | integer |
Who should receive a notification (order owner, customer, custom email) when an order is created. Choices
'"0|1|4|5"'
|
notification_order_owner | integer |
Who should receive a notification (order owner, customer, custom email) when order owner has been changed. Choices
'"0|1|2|3|4|5|6|7"'
|
notification_order_scheduled | integer |
Who should receive a notification (order owner, customer, custom email) when all objects in an order have been scheduled. Choices
'"0|1|2|3|4|5|6|7"'
|
notification_order_started_printing | integer |
Who should receive a notification (order owner, customer, custom email) when the first line item in an order starts printing. Choices
'"0|1|2|3|4|5|6|7"'
|
notification_print_error | integer |
Who should receive a notification (order owner, customer, custom email) when printing fails for any object in an order. Choices
'"0|1|2|3|4|5|6|7"'
|
order_quote_notes_placeholder | string |
Default text for the Order Quote notes section for all bureau orders. |
save_user_rotation | string |
Specify what happens when 3D renderer is exited after making a transformation to the model. Choices
'"never|always|ask_each_time"'
|
scheduling_frequency | integer |
The minimum number of minutes between the end of one scheduling update and the start of another for this same bureau |
uri | URI |
The bureau settings URI. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
/bureau/
Administer information about a bureau. Most users of the ERP module will want to first register a bureau as most other resources in the system expect to take a bureau as a parameter. A bureau is what customers will see when placing orders - in order to generate an order in the system they must indicate which bureau should fulfill the order
Bureaus require a group URI that ties the bureau to a group in the user system. Members of that group will be able to make changes to the bureau and service requests on the bureau
List all of the bureaus in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the bureau. |
group | URI |
The URI of the user group that will get access to orders from the bureau. |
name | string |
The name of the bureau. |
notifications | object |
Allows a bureau to receive emails. Example: ('{"order_summary": "True|False", "order_confirmation": "True|False", '
'"order_scheduled": "True|False", "order_print": "True|False", "order_error": '
'"True|False", "order_shipped": "True|False"}')
|
order_banner | object |
Order banner message intended for restricted users only. Example: '{}'
|
reply_to | string |
Reply to email address for a bureau |
uri | URI |
The URI of the bureau. |
user | URI |
The URI of the user making the bureau. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested bureau name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested bureau cannot be found. |
500 |
|
Create a new bureau.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the bureau. Default: None |
group | URI |
The URI of the user group that will get access to orders from the bureau. Required |
name | string |
The name of the bureau. Required |
notifications | object |
Allows a bureau to receive emails. Default: None Example: ('{"order_summary": "True|False", "order_confirmation": "True|False", '
'"order_scheduled": "True|False", "order_print": "True|False", "order_error": '
'"True|False", "order_shipped": "True|False"}')
|
order_banner | object |
Order banner message intended for restricted users only. Default: None Example: '{}'
|
reply_to | string |
Reply to email address for a bureau Default: None |
uri | URI |
The URI of the bureau. Default: None |
user | URI |
The URI of the user making the bureau. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested bureau name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested bureau cannot be found. |
500 |
|
/bureau/{uuid}/
Administer information about a bureau. Most users of the ERP module will want to first register a bureau as most other resources in the system expect to take a bureau as a parameter. A bureau is what customers will see when placing orders - in order to generate an order in the system they must indicate which bureau should fulfill the order
Bureaus require a group URI that ties the bureau to a group in the user system. Members of that group will be able to make changes to the bureau and service requests on the bureau
Get a single bureau by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the bureau. |
group | URI |
The URI of the user group that will get access to orders from the bureau. |
name | string |
The name of the bureau. |
notifications | object |
Allows a bureau to receive emails. Example: ('{"order_summary": "True|False", "order_confirmation": "True|False", '
'"order_scheduled": "True|False", "order_print": "True|False", "order_error": '
'"True|False", "order_shipped": "True|False"}')
|
order_banner | object |
Order banner message intended for restricted users only. Example: '{}'
|
reply_to | string |
Reply to email address for a bureau |
uri | URI |
The URI of the bureau. |
user | URI |
The URI of the user making the bureau. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested bureau name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested bureau cannot be found. |
500 |
|
Get the parsed content of a capture file
Get the parsed content of a capture by UUID
Schema (application/json)
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
|
Get the parsed content of a capture file
Get the parsed content of a capture by UUID
Schema (application/json)
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
|
/capture-type/
Information about the a modeler-type's capture-type. This is just a placeholder and currently is not implemented.
Schema (application/json)
Property | Type | Description |
---|---|---|
capture_type | string |
none available |
interval | integer |
The rate at which this capture type will capture, in seconds |
modeler_type | URI |
The modeler type this capture is for |
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
Information about the a modeler-type's capture-type. This is just a placeholder and currently is not implemented.
Schema (application/json)
Property | Type | Description |
---|---|---|
capture_type | string |
none available |
interval | integer |
The rate at which this capture type will capture, in seconds |
modeler_type | URI |
The modeler type this capture is for |
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
/capture/
Get and create information about a capture. A capture is a snapshot about what the system is doing at a particular moment in time. The capture resource itself does not contain the data that was captured such as temperature, current job, queue depth, etc. Rather it contains just the metadata about a capture: when it was made, the user the capture was made with, the type of capture, etc.
Get a list of all captures available
Schema (application/json)
Property | Type | Description |
---|---|---|
capture_type | URI |
The URI of the capture-type this capture uses |
capture_type_name | string |
Name of capture type Choices
'"arcam.job.log|catex.modeler.jobs|catex.modeler.status|connex.modeler.log|eos_connect.modeler.log|eos.modeler.log|hp.modeler.status|slm.modeler.status|projet660.modeler.log|ultimaker.modeler.log|stratasys.connectivity.modeler.status|stratasys.connectivity.modeler.historic|carbon3D.modeler.status|formlabs.modeler.status|markforged.modeler.status|renishaw.modeler.log|renishaw.modeler.historic|photocentric.modeler.status"'
|
content_download | URI |
The URL where the capture content can be downloaded |
content_parsed_download | URI |
The URL where the parsed capture content can be downloaded |
content_upload | string |
The URL where the capture content can be uploaded |
created | iso-8601 datetime |
When the capture was created |
meta | object |
Device-specific metadata about the capture Example: 'null'
|
modeler | URI |
The URI of the Modeler this capture belongs to |
printer_names | array |
Printer names which are attached to modeler, which are using this capture.Ideally it must be a string, but theoretically we can have multiple printers attached to the same modelerWill be fixed in ch25564. Example: '["..."]'
|
status | string |
The status of the capture such as 'complete', 'failed', 'processing' or 'new' Choices
'"complete|failed|new|processing"'
|
updated | iso-8601 datetime |
When the capture was last updated |
uri | URI |
The URI of the capture |
user | URI |
The URI of the user making the capture |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
RecordNotFound raised RecordNotFound raised |
Create a new capture
Schema (application/json)
Property | Type | Description |
---|---|---|
capture_type | URI |
The URI of the capture-type this capture uses Required |
capture_type_name | string |
Name of capture type Required Choices
'"arcam.job.log|catex.modeler.jobs|catex.modeler.status|connex.modeler.log|eos_connect.modeler.log|eos.modeler.log|hp.modeler.status|slm.modeler.status|projet660.modeler.log|ultimaker.modeler.log|stratasys.connectivity.modeler.status|stratasys.connectivity.modeler.historic|carbon3D.modeler.status|formlabs.modeler.status|markforged.modeler.status|renishaw.modeler.log|renishaw.modeler.historic|photocentric.modeler.status"'
|
content_download | URI |
The URL where the capture content can be downloaded Default: None |
content_parsed_download | URI |
The URL where the parsed capture content can be downloaded Default: None |
content_upload | string |
The URL where the capture content can be uploaded Default: None |
created | iso-8601 datetime |
When the capture was created Default: None |
meta | object |
Device-specific metadata about the capture Default: None Example: 'null'
|
modeler | URI |
The URI of the Modeler this capture belongs to Required |
printer_names | array |
Printer names which are attached to modeler, which are using this capture.Ideally it must be a string, but theoretically we can have multiple printers attached to the same modelerWill be fixed in ch25564. Required Example: '["..."]'
|
status | string |
The status of the capture such as 'complete', 'failed', 'processing' or 'new' Default: None Choices
'"complete|failed|new|processing"'
|
updated | iso-8601 datetime |
When the capture was last updated Default: None |
uri | URI |
The URI of the capture Default: None |
user | URI |
The URI of the user making the capture Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
RecordNotFound raised RecordNotFound raised |
/capture/{uuid}/
Get and create information about a capture. A capture is a snapshot about what the system is doing at a particular moment in time. The capture resource itself does not contain the data that was captured such as temperature, current job, queue depth, etc. Rather it contains just the metadata about a capture: when it was made, the user the capture was made with, the type of capture, etc.
Get a capture by URI
Schema (application/json)
Property | Type | Description |
---|---|---|
capture_type | URI |
The URI of the capture-type this capture uses |
capture_type_name | string |
Name of capture type Choices
'"arcam.job.log|catex.modeler.jobs|catex.modeler.status|connex.modeler.log|eos_connect.modeler.log|eos.modeler.log|hp.modeler.status|slm.modeler.status|projet660.modeler.log|ultimaker.modeler.log|stratasys.connectivity.modeler.status|stratasys.connectivity.modeler.historic|carbon3D.modeler.status|formlabs.modeler.status|markforged.modeler.status|renishaw.modeler.log|renishaw.modeler.historic|photocentric.modeler.status"'
|
content_download | URI |
The URL where the capture content can be downloaded |
content_parsed_download | URI |
The URL where the parsed capture content can be downloaded |
content_upload | string |
The URL where the capture content can be uploaded |
created | iso-8601 datetime |
When the capture was created |
meta | object |
Device-specific metadata about the capture Example: 'null'
|
modeler | URI |
The URI of the Modeler this capture belongs to |
printer_names | array |
Printer names which are attached to modeler, which are using this capture.Ideally it must be a string, but theoretically we can have multiple printers attached to the same modelerWill be fixed in ch25564. Example: '["..."]'
|
status | string |
The status of the capture such as 'complete', 'failed', 'processing' or 'new' Choices
'"complete|failed|new|processing"'
|
updated | iso-8601 datetime |
When the capture was last updated |
uri | URI |
The URI of the capture |
user | URI |
The URI of the user making the capture |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
RecordNotFound raised RecordNotFound raised |
/carousel/
This endpoint returns data for carousels.
Schema (application/json)
Property | Type | Description |
---|---|---|
parent | URL |
URI of the object that this carousel of images for. |
snapshots | array |
An ordered list of dicts. Each dict is a image in the carosuel. Image 0 is the 'key' image. Example: '[{}]'
|
uri | URI |
URI of this carousel. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
404 |
The requested carousel cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
parent | URL |
URI of the object that this carousel of images for. Required |
snapshots | array |
An ordered list of dicts. Each dict is a image in the carosuel. Image 0 is the 'key' image. Required Example: '[{}]'
|
uri | URI |
URI of this carousel. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
|
404 |
The requested carousel cannot be found. |
405 |
|
This endpoint returns data for carousels.
Schema (application/json)
Property | Type | Description |
---|---|---|
parent | URL |
URI of the object that this carousel of images for. |
snapshots | array |
An ordered list of dicts. Each dict is a image in the carosuel. Image 0 is the 'key' image. Example: '[{}]'
|
uri | URI |
URI of this carousel. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
404 |
The requested carousel cannot be found. |
405 |
|
/cassette/
Control information about cassettes. A cassette is a container of material for a modeler and as such has a link to the material type that the cassette contains. Cassettes are useful for managing inventory of stock material and therefore track their initial quantity and final quantity. The quantity itself does not have a specific unit of measure as different manufacturers will measure their cassettes differently
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the cassette resource was created |
description | string |
A user-supplied description |
initial_material | float |
The initial material the cassette contained. There are no units attached to this measurement because different modelers will use different measurement systems |
manufactured_date | iso-8601 date |
The date the cassette was manufactured |
manufactured_lot | string |
The lot the cassette was manufactured in. This can be useful for quality assurance reasons |
material | URI |
The type of material in the cassette |
modeler | URI |
The modeler the casstte is currently loaded in. If it is not loaded this will be None |
name | string |
The name of the cassette as reported by the modeler |
remaining_material | float |
The amount of material left in the cassette |
serial_number | string |
The serial number of the casstte as reported by the cassette |
spool | string |
The spool of the casstte as reported by the modeler |
status | string |
The status of the cassette Choices
'"active|loaded|unknown"'
|
uri | URI |
The unique URI of this cassette in 3DIAX |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Create a new cassette
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the cassette resource was created Default: None |
description | string |
A user-supplied description Default: None |
initial_material | float |
The initial material the cassette contained. There are no units attached to this measurement because different modelers will use different measurement systems Required |
manufactured_date | iso-8601 date |
The date the cassette was manufactured Default: None |
manufactured_lot | string |
The lot the cassette was manufactured in. This can be useful for quality assurance reasons Default: None |
material | URI |
The type of material in the cassette Default: None |
modeler | URI |
The modeler the casstte is currently loaded in. If it is not loaded this will be None Default: None |
name | string |
The name of the cassette as reported by the modeler Required |
remaining_material | float |
The amount of material left in the cassette Required |
serial_number | string |
The serial number of the casstte as reported by the cassette Required |
spool | string |
The spool of the casstte as reported by the modeler Required |
status | string |
The status of the cassette Required Choices
'"active|loaded|unknown"'
|
uri | URI |
The unique URI of this cassette in 3DIAX Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
Control information about cassettes. A cassette is a container of material for a modeler and as such has a link to the material type that the cassette contains. Cassettes are useful for managing inventory of stock material and therefore track their initial quantity and final quantity. The quantity itself does not have a specific unit of measure as different manufacturers will measure their cassettes differently
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the cassette resource was created |
description | string |
A user-supplied description |
initial_material | float |
The initial material the cassette contained. There are no units attached to this measurement because different modelers will use different measurement systems |
manufactured_date | iso-8601 date |
The date the cassette was manufactured |
manufactured_lot | string |
The lot the cassette was manufactured in. This can be useful for quality assurance reasons |
material | URI |
The type of material in the cassette |
modeler | URI |
The modeler the casstte is currently loaded in. If it is not loaded this will be None |
name | string |
The name of the cassette as reported by the modeler |
remaining_material | float |
The amount of material left in the cassette |
serial_number | string |
The serial number of the casstte as reported by the cassette |
spool | string |
The spool of the casstte as reported by the modeler |
status | string |
The status of the cassette Choices
'"active|loaded|unknown"'
|
uri | URI |
The unique URI of this cassette in 3DIAX |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/castor-costing-config/
For each conversion, Castor can have a few manufacturing configs, with different cost or value settings. This is one manufacturing config, as part of one transaction See parent castor-config for object being priced, and details on material, etc
Schema (application/json)
Property | Type | Description |
---|---|---|
additive_is_cost_saving | boolean |
boolean and text explaining if additive is going to save cost |
additive_lead_time_days | integer |
Est day of delay before mfg additive can begin. |
additive_manufacturable | string |
The part printability result. None if not set yet Choices
'"printable|printable-with-support|printable-with-supports|not-printable"'
|
additive_material_name | string |
name of the additive mfg material for this report |
additive_status | string |
debugging only status |
additive_target_printer | string |
text name of the target printer this configuration is targeting |
additive_target_printer_company | string |
Company that manufactures the printer in additive_target_printer |
additive_total_cost | float |
estimated total cost of Additive mfg process |
castor_costing | URI |
The parent castor costing transaction to this |
configuration_castor_material_id | string |
castor ID for the material in this configuration |
configuration_material | URI |
Matching Authentise material if available, may be null |
configuration_material_name | string |
name of material from the castor system |
configuration_name | string |
name of the user created configuration for this report. |
configuration_quantity | integer |
count of items to consider in this report, from castor |
configuration_status | string |
debugging only cfg status |
configuration_ui_url | URL |
website link to open a view in castor |
configuration_years_of_demand | integer |
years of demand of production |
traditional_lead_time_days | integer |
day of delay before mfg traditional way |
traditional_method_name | string |
name of traditional_manufacturing method |
traditional_total_cost | float |
estimated total cost of traditional mfg for quanity |
uri | URI |
The URI to this record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
Create a new Castor Costing
Schema (application/json)
Property | Type | Description |
---|---|---|
additive_is_cost_saving | boolean |
boolean and text explaining if additive is going to save cost Required |
additive_lead_time_days | integer |
Est day of delay before mfg additive can begin. Required |
additive_manufacturable | string |
The part printability result. None if not set yet Required Choices
'"printable|printable-with-support|printable-with-supports|not-printable"'
|
additive_material_name | string |
name of the additive mfg material for this report Required |
additive_status | string |
debugging only status Required |
additive_target_printer | string |
text name of the target printer this configuration is targeting Required |
additive_target_printer_company | string |
Company that manufactures the printer in additive_target_printer Required |
additive_total_cost | float |
estimated total cost of Additive mfg process Required |
castor_costing | URI |
The parent castor costing transaction to this Required |
configuration_castor_material_id | string |
castor ID for the material in this configuration Required |
configuration_material | URI |
Matching Authentise material if available, may be null Required |
configuration_material_name | string |
name of material from the castor system Required |
configuration_name | string |
name of the user created configuration for this report. Required |
configuration_quantity | integer |
count of items to consider in this report, from castor Required |
configuration_status | string |
debugging only cfg status Required |
configuration_ui_url | URL |
website link to open a view in castor Required |
configuration_years_of_demand | integer |
years of demand of production Required |
traditional_lead_time_days | integer |
day of delay before mfg traditional way Required |
traditional_method_name | string |
name of traditional_manufacturing method Required |
traditional_total_cost | float |
estimated total cost of traditional mfg for quanity Required |
uri | URI |
The URI to this record. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
For each conversion, Castor can have a few manufacturing configs, with different cost or value settings. This is one manufacturing config, as part of one transaction See parent castor-config for object being priced, and details on material, etc
Schema (application/json)
Property | Type | Description |
---|---|---|
additive_is_cost_saving | boolean |
boolean and text explaining if additive is going to save cost |
additive_lead_time_days | integer |
Est day of delay before mfg additive can begin. |
additive_manufacturable | string |
The part printability result. None if not set yet Choices
'"printable|printable-with-support|printable-with-supports|not-printable"'
|
additive_material_name | string |
name of the additive mfg material for this report |
additive_status | string |
debugging only status |
additive_target_printer | string |
text name of the target printer this configuration is targeting |
additive_target_printer_company | string |
Company that manufactures the printer in additive_target_printer |
additive_total_cost | float |
estimated total cost of Additive mfg process |
castor_costing | URI |
The parent castor costing transaction to this |
configuration_castor_material_id | string |
castor ID for the material in this configuration |
configuration_material | URI |
Matching Authentise material if available, may be null |
configuration_material_name | string |
name of material from the castor system |
configuration_name | string |
name of the user created configuration for this report. |
configuration_quantity | integer |
count of items to consider in this report, from castor |
configuration_status | string |
debugging only cfg status |
configuration_ui_url | URL |
website link to open a view in castor |
configuration_years_of_demand | integer |
years of demand of production |
traditional_lead_time_days | integer |
day of delay before mfg traditional way |
traditional_method_name | string |
name of traditional_manufacturing method |
traditional_total_cost | float |
estimated total cost of traditional mfg for quanity |
uri | URI |
The URI to this record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
/castor-costing/
Endpoint to see status of castor conversion. Read only, to trigger re-running, running castor, you need to make a change the related ModelLibrary or Model object.
Castor does a cost review (Mfg Report) of Traditional Manufacturing (TM) estimated cost compared to Additive Manufacturing (AM estimated cost
Schema (application/json)
Property | Type | Description |
---|---|---|
castor_new_config_url | URL |
endpoint to visit to create a new Costing Config with new values |
castor_project_id | string |
project id from Castor. |
currency | string |
The currency of the Mfg Report (USD for MVP). Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
model | URI |
This URL should point to a valid model resource that has already been uploaded. |
model-library | URI |
This URL should point to a parent model-library resource this costing is linked to. |
notes | string |
debugging only error notes, statuses |
process_done_on | iso-8601 datetime |
none available |
sent_on | iso-8601 datetime |
none available |
status | string |
The processing status of this in castor Choices
'"new|pending|project_up|project_up_failed|files_up|files_up_failed|processing|up_to_date|refetch_needed|failed"'
|
updated | iso-8601 datetime |
none available |
uri | URI |
The URI to this record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
Creates a new Castor Costing. This function: 1) creates a promise in db:castor_costing, 2) notifies nautilus-backend to a transaction to Castor3dAPI, 3) returns URI of promised location to have data when transaction / updates are done.
Schema (application/json)
Property | Type | Description |
---|---|---|
castor_new_config_url | URL |
endpoint to visit to create a new Costing Config with new values Required |
castor_project_id | string |
project id from Castor. Required |
currency | string |
The currency of the Mfg Report (USD for MVP). Required Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
model | URI |
This URL should point to a valid model resource that has already been uploaded. Required |
model-library | URI |
This URL should point to a parent model-library resource this costing is linked to. Required |
notes | string |
debugging only error notes, statuses Required |
process_done_on | iso-8601 datetime |
none available Required |
sent_on | iso-8601 datetime |
none available Required |
status | string |
The processing status of this in castor Required Choices
'"new|pending|project_up|project_up_failed|files_up|files_up_failed|processing|up_to_date|refetch_needed|failed"'
|
updated | iso-8601 datetime |
none available Required |
uri | URI |
The URI to this record. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
Endpoint to see status of castor conversion. Read only, to trigger re-running, running castor, you need to make a change the related ModelLibrary or Model object.
Castor does a cost review (Mfg Report) of Traditional Manufacturing (TM) estimated cost compared to Additive Manufacturing (AM estimated cost
Returns a single costing. For now, if not working, or an error state, re-triggers an async update of costing from Castor3d
Schema (application/json)
Property | Type | Description |
---|---|---|
castor_new_config_url | URL |
endpoint to visit to create a new Costing Config with new values |
castor_project_id | string |
project id from Castor. |
currency | string |
The currency of the Mfg Report (USD for MVP). Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
model | URI |
This URL should point to a valid model resource that has already been uploaded. |
model-library | URI |
This URL should point to a parent model-library resource this costing is linked to. |
notes | string |
debugging only error notes, statuses |
process_done_on | iso-8601 datetime |
none available |
sent_on | iso-8601 datetime |
none available |
status | string |
The processing status of this in castor Choices
'"new|pending|project_up|project_up_failed|files_up|files_up_failed|processing|up_to_date|refetch_needed|failed"'
|
updated | iso-8601 datetime |
none available |
uri | URI |
The URI to this record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
/comment-action/
As an MVP use of assignments, this allows to manage comment actions
(comment actions can be craeted
only vic /comment/
API for now).
A comment action is assigning a user to do the task/request that is written in a comment.
This object is basically just an updatable status, most fields are read-only (taken from the comment
).
Once assigned, only the assignee can PUT to change statuses.
Schema (application/json)
Property | Type | Description |
---|---|---|
assignee_user | URI |
The URI of the user who is responsible to do the task from the comment. |
comment | URI |
The URI of the related comment. |
completed | iso-8601 datetime |
Datetime when comment action was marked as 'complete' (in UTC). |
created | iso-8601 datetime |
Datetime when comment action was created (in UTC). |
created_by | URI |
The URI of the author for the comment action (and comment). |
related_table_name | string |
The resource (related table name), to which related comment is attached, for example order, line_item, etc. Choices
'"order|line_item|prep_task_record|model_library|run|service_provider_job|piece"'
|
related_uri | URL |
URI of the exact object that related comment is related to. |
related_uuid | uuid |
The UUID of the resource (related table), to which related comment is attached. |
status | string |
Status of the comment action, only assignee_user can edit. Choices
'"new|in-progress|complete"'
|
updated | iso-8601 datetime |
Datetime when comment action was updated last time (in UTC). |
uri | URI |
The URI of the comment action. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested comment action cannot be found. |
As an MVP use of assignments, this allows to manage comment actions
(comment actions can be craeted
only vic /comment/
API for now).
A comment action is assigning a user to do the task/request that is written in a comment.
This object is basically just an updatable status, most fields are read-only (taken from the comment
).
Once assigned, only the assignee can PUT to change statuses.
Schema (application/json)
Property | Type | Description |
---|---|---|
assignee_user | URI |
The URI of the user who is responsible to do the task from the comment. |
comment | URI |
The URI of the related comment. |
completed | iso-8601 datetime |
Datetime when comment action was marked as 'complete' (in UTC). |
created | iso-8601 datetime |
Datetime when comment action was created (in UTC). |
created_by | URI |
The URI of the author for the comment action (and comment). |
related_table_name | string |
The resource (related table name), to which related comment is attached, for example order, line_item, etc. Choices
'"order|line_item|prep_task_record|model_library|run|service_provider_job|piece"'
|
related_uri | URL |
URI of the exact object that related comment is related to. |
related_uuid | uuid |
The UUID of the resource (related table), to which related comment is attached. |
status | string |
Status of the comment action, only assignee_user can edit. Choices
'"new|in-progress|complete"'
|
updated | iso-8601 datetime |
Datetime when comment action was updated last time (in UTC). |
uri | URI |
The URI of the comment action. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested comment action cannot be found. |
/comment/
Common comments
API for managing (creating, receiving, editing) comments
for different resource: right now we support only order
, but in the future we planning
to provide support for line_item
, service_provider_job
, run
, piece
(see :class:nautilus.constants.CommentRelatedTableName
for up to date list of supported resource).
Schema (application/json)
Property | Type | Description |
---|---|---|
author_name | string |
The name of the comment's author. |
comment_action | object |
none available Example: ('{"status": "new|in-progress|complete", "related_table_name": '
'"order|line_item|prep_task_record|model_library|run|service_provider_job|piece"}')
|
created | iso-8601 datetime |
Datetime when comment was created (in UTC). |
mentioned_users | array |
Info about users which were mentioned in the comment. During the POST/PUT we working only with 'uri' field. On PUT we using the next rules: - 1. if we will receive new user URI in the list - we will consider that a new user was mentioned in the comment during comment editing (email will be send); - 2. if user, which was mentioned before, will not be listed in the list - it will be removed from the mentions list. Example: '[{}]'
|
related_table_name | string |
The resource (related table name), to which this comment is attached, for example order, line_item, etc. Choices
'"order|line_item|prep_task_record|model_library|run|service_provider_job|piece"'
|
related_uuid | uuid |
The UUID of the resource (related table), to which this comment is attached. |
text | string |
The text of the comment in markdown. Note that hash-tagged text will auto-generate a label if labels are enabled on that resource. MVP is on model-library |
text_ilike | boolean |
none available |
updated | iso-8601 datetime |
Datetime when comment was updated last time (in UTC). |
uri | URI |
The URI of the comment. |
user | URI |
The URI of the comment's author. |
username | string |
The username (email) of the comment's author. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Filtering using text_ilike requires a related_table_name filter Filtering using text_ilike is not valid for comments on this table Filtering using text_ilike is only valid if a text filter is also provided |
403 |
Modification of the comment allowed only for comment owner. |
404 |
The requested comment cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
author_name | string |
The name of the comment's author. Required |
comment_action | object |
none available Required Example: ('{"status": "new|in-progress|complete", "related_table_name": '
'"order|line_item|prep_task_record|model_library|run|service_provider_job|piece"}')
|
created | iso-8601 datetime |
Datetime when comment was created (in UTC). Required |
mentioned_users | array |
Info about users which were mentioned in the comment. During the POST/PUT we working only with 'uri' field. On PUT we using the next rules: - 1. if we will receive new user URI in the list - we will consider that a new user was mentioned in the comment during comment editing (email will be send); - 2. if user, which was mentioned before, will not be listed in the list - it will be removed from the mentions list. Required Example: '[{}]'
|
related_table_name | string |
The resource (related table name), to which this comment is attached, for example order, line_item, etc. Required Choices
'"order|line_item|prep_task_record|model_library|run|service_provider_job|piece"'
|
related_uuid | uuid |
The UUID of the resource (related table), to which this comment is attached. Required |
text | string |
The text of the comment in markdown. Note that hash-tagged text will auto-generate a label if labels are enabled on that resource. MVP is on model-library Required |
text_ilike | boolean |
none available Default: False |
updated | iso-8601 datetime |
Datetime when comment was updated last time (in UTC). Required |
uri | URI |
The URI of the comment. Required |
user | URI |
The URI of the comment's author. Required |
username | string |
The username (email) of the comment's author. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Filtering using text_ilike requires a related_table_name filter Filtering using text_ilike is not valid for comments on this table Filtering using text_ilike is only valid if a text filter is also provided |
403 |
Modification of the comment allowed only for comment owner. |
404 |
The requested comment cannot be found. |
/comment/{uuid}/
Common comments
API for managing (creating, receiving, editing) comments
for different resource: right now we support only order
, but in the future we planning
to provide support for line_item
, service_provider_job
, run
, piece
(see :class:nautilus.constants.CommentRelatedTableName
for up to date list of supported resource).
Schema (application/json)
Property | Type | Description |
---|---|---|
author_name | string |
The name of the comment's author. |
comment_action | object |
none available Example: ('{"status": "new|in-progress|complete", "related_table_name": '
'"order|line_item|prep_task_record|model_library|run|service_provider_job|piece"}')
|
created | iso-8601 datetime |
Datetime when comment was created (in UTC). |
mentioned_users | array |
Info about users which were mentioned in the comment. During the POST/PUT we working only with 'uri' field. On PUT we using the next rules: - 1. if we will receive new user URI in the list - we will consider that a new user was mentioned in the comment during comment editing (email will be send); - 2. if user, which was mentioned before, will not be listed in the list - it will be removed from the mentions list. Example: '[{}]'
|
related_table_name | string |
The resource (related table name), to which this comment is attached, for example order, line_item, etc. Choices
'"order|line_item|prep_task_record|model_library|run|service_provider_job|piece"'
|
related_uuid | uuid |
The UUID of the resource (related table), to which this comment is attached. |
text | string |
The text of the comment in markdown. Note that hash-tagged text will auto-generate a label if labels are enabled on that resource. MVP is on model-library |
text_ilike | boolean |
none available |
updated | iso-8601 datetime |
Datetime when comment was updated last time (in UTC). |
uri | URI |
The URI of the comment. |
user | URI |
The URI of the comment's author. |
username | string |
The username (email) of the comment's author. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Filtering using text_ilike requires a related_table_name filter Filtering using text_ilike is not valid for comments on this table Filtering using text_ilike is only valid if a text filter is also provided |
403 |
Modification of the comment allowed only for comment owner. |
404 |
The requested comment cannot be found. |
/config/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
none available |
description | string |
none available |
engine | string |
none available Choices
'"slic3r"'
|
name | string |
none available |
parameters | object |
none available Example: ('{"bed_shape": "rectangular|circular", "material": "ABS|PLA", '
'"part_interior": "solid|sparse|semisparse", "print_quality": '
'"low|standard|fine", "support_style": '
'"basic|breakaway|covex|sparse|surround", "units": "mm|inches"}')
|
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
none available Default: None |
description | string |
none available Default:
|
engine | string |
none available Default: slic3r Choices
'"slic3r"'
|
name | string |
none available Default:
|
parameters | object |
none available Default: None Example: ('{"bed_shape": "rectangular|circular", "material": "ABS|PLA", '
'"part_interior": "solid|sparse|semisparse", "print_quality": '
'"low|standard|fine", "support_style": '
'"basic|breakaway|covex|sparse|surround", "units": "mm|inches"}')
|
uri | URI |
none available Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
/config/curated/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
none available Default:
|
engine | string |
none available Required Choices
'"slic3r"'
|
name | string |
none available Default:
|
parameters | object |
none available Default: {'material': 'PLA', 'print_quality': 'standard', 'filament_diameter': 1.75, 'nozzle_diameter': '0.4', 'infill_density': 20.0, 'infill_speed': 40.0, 'extruder_temperature': 230.0, 'bed_shape': 'rectangular', 'bed_size_x_r': 200.0, 'bed_size_y': 200.0, 'bed_temperature': 0.0, 'part_interior': 'sparse', 'perimeters': 2, 'perimeter_speed': 40.0, 'scale': 1, 'support': False, 'support_style': 'sparse', 'raft': False, 'units': 'mm'} Example: ('{"bed_shape": "rectangular|circular", "material": "ABS|PLA", '
'"part_interior": "solid|sparse|semisparse", "print_quality": '
'"low|standard|fine", "support_style": '
'"basic|breakaway|covex|sparse|surround", "units": "mm|inches"}')
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
/config/raw/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
none available Required |
description | string |
none available Default:
|
engine | string |
none available Required Choices
'"slic3r"'
|
name | string |
none available Default:
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
/config/{uuid}/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
none available |
description | string |
none available |
engine | string |
none available Choices
'"slic3r"'
|
name | string |
none available |
parameters | object |
none available Example: ('{"bed_shape": "rectangular|circular", "material": "ABS|PLA", '
'"part_interior": "solid|sparse|semisparse", "print_quality": '
'"low|standard|fine", "support_style": '
'"basic|breakaway|covex|sparse|surround", "units": "mm|inches"}')
|
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/contact-us/
POST only endpoint, to send an email to customer support, on behalf of a user. This may move to post to an internal ticketing system or more in the future. This is VERY MVP for a shipping deadline. Only for Hawking project for now.
Schema (application/json)
Property | Type | Description |
---|---|---|
support_request_payload | string |
Plain text, or markdown formatted, request from customer. This is passed to customer support system Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
/content/{uuid}/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
runs with GET endpoint for content is hit. Resolves (and decrypts content to send back (content = a blob of data) @returns a flask response obj containing the content
Schema (application/json)
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
404 |
|
/cost-report/
This is the main resource for cost reporting over a given period of time.
Schema (application/json)
Property | Type | Description |
---|---|---|
cost | float |
cost associated with report Example: '"100.00"'
|
cost_per_mm3 | float |
cost per mm3 associated with report Example: '"1.2"'
|
end | iso-8601 datetime |
Ending date of this report |
material | URI |
URI of material used. You get the list of materials from GET/material/ Example: '"https://quoting.authentise.com/material/123456/"'
|
start | iso-8601 datetime |
Beginning date of this report |
uri | URI |
The URI for each specific cost report |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
start and/or end date cannot be a future date. Cost must be a positive value A cost report must be unique, and cannot intersect other reports date range Must provide a valid material |
Schema (application/json)
Property | Type | Description |
---|---|---|
cost | float |
cost associated with report Required Example: '"100.00"'
|
cost_per_mm3 | float |
cost per mm3 associated with report Default: None Example: '"1.2"'
|
end | iso-8601 datetime |
Ending date of this report Required |
material | URI |
URI of material used. You get the list of materials from GET/material/ Default: None Example: '"https://quoting.authentise.com/material/123456/"'
|
start | iso-8601 datetime |
Beginning date of this report Required |
uri | URI |
The URI for each specific cost report Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
start and/or end date cannot be a future date. Cost must be a positive value A cost report must be unique, and cannot intersect other reports date range Must provide a valid material |
This is the main resource for cost reporting over a given period of time.
Schema (application/json)
Property | Type | Description |
---|---|---|
cost | float |
cost associated with report Example: '"100.00"'
|
cost_per_mm3 | float |
cost per mm3 associated with report Example: '"1.2"'
|
end | iso-8601 datetime |
Ending date of this report |
material | URI |
URI of material used. You get the list of materials from GET/material/ Example: '"https://quoting.authentise.com/material/123456/"'
|
start | iso-8601 datetime |
Beginning date of this report |
uri | URI |
The URI for each specific cost report |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
start and/or end date cannot be a future date. Cost must be a positive value A cost report must be unique, and cannot intersect other reports date range Must provide a valid material |
/create-runs/
Provide possibility to create "printing" (we support only printing runs for now - because this is all we need for API and creation of post-processing and shipping run were not implemented properly before regarding to further runs) run with all further runs. Also provides possibility to track state of runs creation process and see results: info about created runs or info why run cannot be created.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The datetime the records was created |
do_build_volume_check | boolean |
When set, run is checked for ability to fit into the specificed printer_type build volume. Prints that do not fit are left |
finished | iso-8601 datetime |
The datetime the process was finished, |
locked | boolean |
When locked, created runs cannot have a (user? nautilus-backed) add printes or pieces to any created run. |
notes | string |
System Notes for the run creation process. |
pieces | array |
The URIs of exact instances/ pieces to create runs for, and schedule into the manufacturing runs . Example: '["..."]'
|
pieces_count | integer |
The count of all pieces, used in the process. |
primary_run | URI |
The URI of the resulting primary run (printing/post-processing). |
primary_run_duration | timedelta |
Override the Duration of primary manufacturing run when planning the schedule, if set |
primary_workstation | URL |
The URI of a printer (additive-workflow) or post_processor (powder-workflow) that is primary manufacturing step. |
printer_name | string |
Name of the related printer, |
priority | integer |
The priority score for the run, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
resulting_runs | array |
URIs of the resulting runs: printing_run + all created and/or infilled runs. Example: '["..."]'
|
resulting_runs_count | integer |
The count of resulting runs. |
run_name | string |
Name of a run. |
status | string |
Status of the run creation process. Choices
'"pending|processing|complete|error"'
|
unfitted_pieces | array |
URIs of pieces (a subset of 'pieces' from POST payload) which were not fitted into the printer build plate. Example: '["..."]'
|
updated | iso-8601 datetime |
The date the run was updated. |
uri | URI |
The URI of the run. |
user | URI |
User which requested runs creation. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Run cannot consist of pieces with models and without models at the same time. The requested prints do not have their associated line_items in either confirmed or printing state. |
404 |
The requested runs creation process or related object cannot be found. |
Post to notify server action reuqest to make runs. Computationally heavy, makes promise here, real code runs on nautilus-backend async.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The datetime the records was created Required |
do_build_volume_check | boolean |
When set, run is checked for ability to fit into the specificed printer_type build volume. Prints that do not fit are left Default: True |
finished | iso-8601 datetime |
The datetime the process was finished, Required |
locked | boolean |
When locked, created runs cannot have a (user? nautilus-backed) add printes or pieces to any created run. Default: True |
notes | string |
System Notes for the run creation process. Required |
pieces | array |
The URIs of exact instances/ pieces to create runs for, and schedule into the manufacturing runs . Required Example: '["..."]'
|
pieces_count | integer |
The count of all pieces, used in the process. Required |
primary_run | URI |
The URI of the resulting primary run (printing/post-processing). Required |
primary_run_duration | timedelta |
Override the Duration of primary manufacturing run when planning the schedule, if set Default: None |
primary_workstation | URL |
The URI of a printer (additive-workflow) or post_processor (powder-workflow) that is primary manufacturing step. Required |
printer_name | string |
Name of the related printer, Required |
priority | integer |
The priority score for the run, in range 0-100, where 0 is the lowest priority and 100 is the highest priority Default: 65 |
resulting_runs | array |
URIs of the resulting runs: printing_run + all created and/or infilled runs. Required Example: '["..."]'
|
resulting_runs_count | integer |
The count of resulting runs. Required |
run_name | string |
Name of a run. Required |
status | string |
Status of the run creation process. Required Choices
'"pending|processing|complete|error"'
|
unfitted_pieces | array |
URIs of pieces (a subset of 'pieces' from POST payload) which were not fitted into the printer build plate. Required Example: '["..."]'
|
updated | iso-8601 datetime |
The date the run was updated. Required |
uri | URI |
The URI of the run. Required |
user | URI |
User which requested runs creation. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Run cannot consist of pieces with models and without models at the same time. The requested prints do not have their associated line_items in either confirmed or printing state. |
404 |
The requested runs creation process or related object cannot be found. |
Provide possibility to create "printing" (we support only printing runs for now - because this is all we need for API and creation of post-processing and shipping run were not implemented properly before regarding to further runs) run with all further runs. Also provides possibility to track state of runs creation process and see results: info about created runs or info why run cannot be created.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The datetime the records was created |
do_build_volume_check | boolean |
When set, run is checked for ability to fit into the specificed printer_type build volume. Prints that do not fit are left |
finished | iso-8601 datetime |
The datetime the process was finished, |
locked | boolean |
When locked, created runs cannot have a (user? nautilus-backed) add printes or pieces to any created run. |
notes | string |
System Notes for the run creation process. |
pieces | array |
The URIs of exact instances/ pieces to create runs for, and schedule into the manufacturing runs . Example: '["..."]'
|
pieces_count | integer |
The count of all pieces, used in the process. |
primary_run | URI |
The URI of the resulting primary run (printing/post-processing). |
primary_run_duration | timedelta |
Override the Duration of primary manufacturing run when planning the schedule, if set |
primary_workstation | URL |
The URI of a printer (additive-workflow) or post_processor (powder-workflow) that is primary manufacturing step. |
printer_name | string |
Name of the related printer, |
priority | integer |
The priority score for the run, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
resulting_runs | array |
URIs of the resulting runs: printing_run + all created and/or infilled runs. Example: '["..."]'
|
resulting_runs_count | integer |
The count of resulting runs. |
run_name | string |
Name of a run. |
status | string |
Status of the run creation process. Choices
'"pending|processing|complete|error"'
|
unfitted_pieces | array |
URIs of pieces (a subset of 'pieces' from POST payload) which were not fitted into the printer build plate. Example: '["..."]'
|
updated | iso-8601 datetime |
The date the run was updated. |
uri | URI |
The URI of the run. |
user | URI |
User which requested runs creation. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Run cannot consist of pieces with models and without models at the same time. The requested prints do not have their associated line_items in either confirmed or printing state. |
404 |
The requested runs creation process or related object cannot be found. |
/currency-conversion/
Currency Conversion is an endpoint which works with /material/ and /shipping/. Once an order has a currency specified, we will be able to calculate the material cost and shipping cost for a bureau and currency mentioned in the order.
List all of the currency conversion in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
currency | string |
Currency abbreviation. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
is_bureau_default | boolean |
Is this Bureau default currency or not. |
updated | iso-8601 datetime |
When the currency conversion was updated. |
uri | URI |
The URI for currency conversion. |
value | float |
The currency conversion value for a particular currency and bureau. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
A currency-conversion with this bureau and currency already exists. |
403 |
You are not authorized to complete the request. Editing currency (currently, only bureau default) not allowed. |
404 |
The requested currency-conversion cannot be found. |
Create a new currency conversion.
Schema (application/json)
Property | Type | Description |
---|---|---|
currency | string |
Currency abbreviation. Required Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
is_bureau_default | boolean |
Is this Bureau default currency or not. Required |
updated | iso-8601 datetime |
When the currency conversion was updated. Required |
uri | URI |
The URI for currency conversion. Required |
value | float |
The currency conversion value for a particular currency and bureau. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
A currency-conversion with this bureau and currency already exists. |
403 |
You are not authorized to complete the request. Editing currency (currently, only bureau default) not allowed. |
404 |
The requested currency-conversion cannot be found. |
Currency Conversion is an endpoint which works with /material/ and /shipping/. Once an order has a currency specified, we will be able to calculate the material cost and shipping cost for a bureau and currency mentioned in the order.
Get an individual currency conversion resource by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
currency | string |
Currency abbreviation. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
is_bureau_default | boolean |
Is this Bureau default currency or not. |
updated | iso-8601 datetime |
When the currency conversion was updated. |
uri | URI |
The URI for currency conversion. |
value | float |
The currency conversion value for a particular currency and bureau. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
A currency-conversion with this bureau and currency already exists. |
403 |
You are not authorized to complete the request. Editing currency (currently, only bureau default) not allowed. |
404 |
The requested currency-conversion cannot be found. |
/custom-group/
Public groups (bureau is not None) are groups which are bureau manager create/deletable created by bureau users via Frontend app and used for custom permissions checks (not used for "role" and common "permissions" apps).
Schema (application/json)
Property | Type | Description |
---|---|---|
by_user | URI |
Allow to filtering groups by member(s) (users). |
created | iso-8601 datetime |
The date when the group was created. |
description | string |
The description of the group. |
members | array |
List of group members (users). Example: '["..."]'
|
name | string |
The name of the group. |
updated | iso-8601 datetime |
The date when the group was updated. |
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
Create, edit and delete groups can only bureau manager. |
404 |
The requested group cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
by_user | URI |
Allow to filtering groups by member(s) (users). Required |
created | iso-8601 datetime |
The date when the group was created. Required |
description | string |
The description of the group. Required |
members | array |
List of group members (users). Required Example: '["..."]'
|
name | string |
The name of the group. Required |
updated | iso-8601 datetime |
The date when the group was updated. Required |
uri | URI |
none available Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
Create, edit and delete groups can only bureau manager. |
404 |
The requested group cannot be found. |
Public groups (bureau is not None) are groups which are bureau manager create/deletable created by bureau users via Frontend app and used for custom permissions checks (not used for "role" and common "permissions" apps).
Schema (application/json)
Property | Type | Description |
---|---|---|
by_user | URI |
Allow to filtering groups by member(s) (users). |
created | iso-8601 datetime |
The date when the group was created. |
description | string |
The description of the group. |
members | array |
List of group members (users). Example: '["..."]'
|
name | string |
The name of the group. |
updated | iso-8601 datetime |
The date when the group was updated. |
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
Create, edit and delete groups can only bureau manager. |
404 |
The requested group cannot be found. |
/custom-settings//
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/custom_field/
Read only endpoint for CustomField records. There are 2 kinds (dumb) Custom Fields, and Smart Custom Fields. Custom Fields are read only and can be created only via admin script admin/add_custom_field.py. Created custom fields will be displayed on the frontend as regular form element; data, entered by user for these fields will be created as Custom Fields Value. Smart Custom Fields can be set by Nautilus, but they can never change/set a nautilus non-custom field value (maybe). See repo internal_docs file source/custom_fields.md for design details.
Schema (application/json)
Property | Type | Description |
---|---|---|
default_value | string |
Default value for Custom Field Value on create. |
description | string |
Bureau Managers description of this resource. Do not confuse with tooltip |
edited_by | URI |
The URI of the user that last edited this custom field. If null, admin script or import added it. |
enabled | boolean |
Is field disabled or not |
field_id | string |
String human readable ID of custom field. |
field_name | string |
Name of custom field. |
format | string |
Optional additional info for the value type, for example, for float field this can indicate that this is a currency. Choices
'"currency"'
|
is_smart | boolean |
Is field 'smart': used in business logic. |
is_visible_for_restricted | boolean |
Is field visible to restricted users? Note: This field controls an aesthetic change only. Data is still delivered to the front-end and is not securely hidden from restricted users. This only changes whether the data is rendered in the UI |
meta | object |
Dict with meta info on custom field. Example: '{}'
|
options | array |
Array with possible options of custom field. Example: '[{"meta": null}]'
|
position | integer |
Represents position of custom field in the rendered fields block. If null, it means that block is a special case, to be manually rendered outside of main form fields |
related_table_name | string |
Table with which the value is associated. |
required | boolean |
Is field required or not |
rights | array |
Right (actions) which user has on the custom field. Example: '["read|write"]'
|
type | string |
Type of custom field. Text, integer, etc. Choices
'"text|textarea|table|integer|float|array|date|checkbox|url"'
|
uri | URI |
The URI of the custom field. |
use_count | integer |
Count of the relate custom_field_values items in the database. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
Create, edit and delete custom field can only bureau manager. |
404 |
RecordNotFound raised |
Schema (application/json)
Property | Type | Description |
---|---|---|
default_value | string |
Default value for Custom Field Value on create. Default: None |
description | string |
Bureau Managers description of this resource. Do not confuse with tooltip Default: No details on this custom - field |
edited_by | URI |
The URI of the user that last edited this custom field. If null, admin script or import added it. Required |
enabled | boolean |
Is field disabled or not Default: True |
field_id | string |
String human readable ID of custom field. Required |
field_name | string |
Name of custom field. Required |
format | string |
Optional additional info for the value type, for example, for float field this can indicate that this is a currency. Required Choices
'"currency"'
|
is_smart | boolean |
Is field 'smart': used in business logic. Required |
is_visible_for_restricted | boolean |
Is field visible to restricted users? Note: This field controls an aesthetic change only. Data is still delivered to the front-end and is not securely hidden from restricted users. This only changes whether the data is rendered in the UI Default: True |
meta | object |
Dict with meta info on custom field. Default: {} Example: '{}'
|
options | array |
Array with possible options of custom field. Required Example: '[{"meta": null}]'
|
position | integer |
Represents position of custom field in the rendered fields block. If null, it means that block is a special case, to be manually rendered outside of main form fields Required |
related_table_name | string |
Table with which the value is associated. Required |
required | boolean |
Is field required or not Default: False |
rights | array |
Right (actions) which user has on the custom field. Required Example: '["read|write"]'
|
type | string |
Type of custom field. Text, integer, etc. Required Choices
'"text|textarea|table|integer|float|array|date|checkbox|url"'
|
uri | URI |
The URI of the custom field. Required |
use_count | integer |
Count of the relate custom_field_values items in the database. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
Create, edit and delete custom field can only bureau manager. |
404 |
RecordNotFound raised |
Read only endpoint for CustomField records. There are 2 kinds (dumb) Custom Fields, and Smart Custom Fields. Custom Fields are read only and can be created only via admin script admin/add_custom_field.py. Created custom fields will be displayed on the frontend as regular form element; data, entered by user for these fields will be created as Custom Fields Value. Smart Custom Fields can be set by Nautilus, but they can never change/set a nautilus non-custom field value (maybe). See repo internal_docs file source/custom_fields.md for design details.
Schema (application/json)
Property | Type | Description |
---|---|---|
default_value | string |
Default value for Custom Field Value on create. |
description | string |
Bureau Managers description of this resource. Do not confuse with tooltip |
edited_by | URI |
The URI of the user that last edited this custom field. If null, admin script or import added it. |
enabled | boolean |
Is field disabled or not |
field_id | string |
String human readable ID of custom field. |
field_name | string |
Name of custom field. |
format | string |
Optional additional info for the value type, for example, for float field this can indicate that this is a currency. Choices
'"currency"'
|
is_smart | boolean |
Is field 'smart': used in business logic. |
is_visible_for_restricted | boolean |
Is field visible to restricted users? Note: This field controls an aesthetic change only. Data is still delivered to the front-end and is not securely hidden from restricted users. This only changes whether the data is rendered in the UI |
meta | object |
Dict with meta info on custom field. Example: '{}'
|
options | array |
Array with possible options of custom field. Example: '[{"meta": null}]'
|
position | integer |
Represents position of custom field in the rendered fields block. If null, it means that block is a special case, to be manually rendered outside of main form fields |
related_table_name | string |
Table with which the value is associated. |
required | boolean |
Is field required or not |
rights | array |
Right (actions) which user has on the custom field. Example: '["read|write"]'
|
type | string |
Type of custom field. Text, integer, etc. Choices
'"text|textarea|table|integer|float|array|date|checkbox|url"'
|
uri | URI |
The URI of the custom field. |
use_count | integer |
Count of the relate custom_field_values items in the database. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
Create, edit and delete custom field can only bureau manager. |
404 |
RecordNotFound raised |
/design-file/
Design file responsible for processing uploaded by users 3D model files.
Via this API user can create a new design file (for now, only for products) which will create
design file itself and will return in HTTP headers X-Upload-Location
to which should be uploaded
file content. As the edge case, for the DesignFileType.single_mesh
api will also create db:model
and return it in HTTP headers Model-Location
.
When user/frontend will upload file content to the X-Upload-Location
design file will run unpacking backend
process which will scan this file for viruses and then perform additional checks and run further logic.
Here is supported and FUTURE plans/logic for different design file formats::
1. **STL files** - this is the main file format that we are supporting from the start and which used in most
of internal logic. Design file backend logic will just ensure that STL file is correct and will delegate to
another backend process further logic, related to calculating model volume, size, etc.
2. <CLOSE FUTURE> Single-mesh non-STL file formats - design file will run/delegate conversion of these files to STL
to another service and will expect signals (most probably, via the "event-listener" service or some other "*-listener"
service) about successful or unsuccessful completion and then will run the same logic as for STL files.
3. <FUTURE> Anatomical models and 3MF file formats - these are file formats that can contain more than one model
and have much more advanced structure rather than STL and part of single-mesh formats.
Design file backend process will analyze and unpack this files into few (in edge cases, into single) line-items
and models (or another entity for it - this is still WIP).
List all design file.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
Download URI for the design file. Link is valid for 5 minutes by default. |
created | iso-8601 datetime |
Datetime when anatomical model was created (in UTC). |
file_size | integer |
The file size in bytes. Filled by background process |
format | string |
File format of the design file. Choices
'"3dm|3dpdf|3mf|amf|asm|catpart|catproduct|dae|iam|iges|igs|ipt|jt|j_t|model|obj|pdf|png|prt|sat|skp|sldasm|sldprt|step|stp|stl|tif|tiff|x_t|xt"'
|
name | string |
The filename with extension of design file. |
notes | string |
System or user notes for the design file. |
product | URI |
Exiting product, to update or overwrite with the unpacked design file. |
status | string |
Status of a backend processing job unpacking the design file. Choices
'"new|processing|processed|error"'
|
type | string |
Describe general type of the input file which will affect/'help to pick' correct backend logic for the design/input file. Choices
'"single-mesh"'
|
updated | iso-8601 datetime |
Datetime when anatomical model was updated last time (in UTC). |
upload_location | string |
Upload location for the design file. Link is valid for 5 minutes by default. |
uri | URI |
The URI of this design file. |
user | URI |
A user which uploaded the design file. |
virus_scan | string |
Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected. Choices
'"unscanned|passed|quarantined"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested design file cannot be found. |
405 |
|
Create a new record of a Design File in the db.
After POST the design file is promised, but the design file has not landed, been virus scanned, or unpacked into other resources.
Returns in HTTP headers next additional values:
- Location
- the URI of the created design_file;
- X-Upload-Location
- the URI to which should be uploaded file content;
- DesignFileType.single_mesh
only - will be created db:model and it is URI will be returned as Model-Location
.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
Download URI for the design file. Link is valid for 5 minutes by default. Required |
created | iso-8601 datetime |
Datetime when anatomical model was created (in UTC). Required |
file_size | integer |
The file size in bytes. Filled by background process Required |
format | string |
File format of the design file. Required Choices
'"3dm|3dpdf|3mf|amf|asm|catpart|catproduct|dae|iam|iges|igs|ipt|jt|j_t|model|obj|pdf|png|prt|sat|skp|sldasm|sldprt|step|stp|stl|tif|tiff|x_t|xt"'
|
name | string |
The filename with extension of design file. Required |
notes | string |
System or user notes for the design file. Required |
product | URI |
Exiting product, to update or overwrite with the unpacked design file. Required |
status | string |
Status of a backend processing job unpacking the design file. Required Choices
'"new|processing|processed|error"'
|
type | string |
Describe general type of the input file which will affect/'help to pick' correct backend logic for the design/input file. Required Choices
'"single-mesh"'
|
updated | iso-8601 datetime |
Datetime when anatomical model was updated last time (in UTC). Required |
upload_location | string |
Upload location for the design file. Link is valid for 5 minutes by default. Required |
uri | URI |
The URI of this design file. Required |
user | URI |
A user which uploaded the design file. Required |
virus_scan | string |
Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected. Default: unscanned Choices
'"unscanned|passed|quarantined"'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested design file cannot be found. |
405 |
|
Design file responsible for processing uploaded by users 3D model files.
Via this API user can create a new design file (for now, only for products) which will create
design file itself and will return in HTTP headers X-Upload-Location
to which should be uploaded
file content. As the edge case, for the DesignFileType.single_mesh
api will also create db:model
and return it in HTTP headers Model-Location
.
When user/frontend will upload file content to the X-Upload-Location
design file will run unpacking backend
process which will scan this file for viruses and then perform additional checks and run further logic.
Here is supported and FUTURE plans/logic for different design file formats::
1. **STL files** - this is the main file format that we are supporting from the start and which used in most
of internal logic. Design file backend logic will just ensure that STL file is correct and will delegate to
another backend process further logic, related to calculating model volume, size, etc.
2. <CLOSE FUTURE> Single-mesh non-STL file formats - design file will run/delegate conversion of these files to STL
to another service and will expect signals (most probably, via the "event-listener" service or some other "*-listener"
service) about successful or unsuccessful completion and then will run the same logic as for STL files.
3. <FUTURE> Anatomical models and 3MF file formats - these are file formats that can contain more than one model
and have much more advanced structure rather than STL and part of single-mesh formats.
Design file backend process will analyze and unpack this files into few (in edge cases, into single) line-items
and models (or another entity for it - this is still WIP).
Get an design file by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
Download URI for the design file. Link is valid for 5 minutes by default. |
created | iso-8601 datetime |
Datetime when anatomical model was created (in UTC). |
file_size | integer |
The file size in bytes. Filled by background process |
format | string |
File format of the design file. Choices
'"3dm|3dpdf|3mf|amf|asm|catpart|catproduct|dae|iam|iges|igs|ipt|jt|j_t|model|obj|pdf|png|prt|sat|skp|sldasm|sldprt|step|stp|stl|tif|tiff|x_t|xt"'
|
name | string |
The filename with extension of design file. |
notes | string |
System or user notes for the design file. |
product | URI |
Exiting product, to update or overwrite with the unpacked design file. |
status | string |
Status of a backend processing job unpacking the design file. Choices
'"new|processing|processed|error"'
|
type | string |
Describe general type of the input file which will affect/'help to pick' correct backend logic for the design/input file. Choices
'"single-mesh"'
|
updated | iso-8601 datetime |
Datetime when anatomical model was updated last time (in UTC). |
upload_location | string |
Upload location for the design file. Link is valid for 5 minutes by default. |
uri | URI |
The URI of this design file. |
user | URI |
A user which uploaded the design file. |
virus_scan | string |
Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected. Choices
'"unscanned|passed|quarantined"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested design file cannot be found. |
405 |
|
/document/
Documents are a special resource. This is to track and upload files of (many)
kinds and link them to another resource. Instead of adding document
all over
the API, we have one document endpoint that tracks 'related_resource/uuid' of
what it is attached to.
POST to this endpoint to create a new promise of a document. On success, the promise replies with an OK in the reply's X-Upload-Location header. Use the X-Upload-location header to stream the raw contents of the file via PUT.
Example: User has a PDF file they want to attach to a material. They POST to this endpoint with:
{ "related_table_name": 'material', "related_uuid":UUID, ... }
If accepted, the caller receives a reply HTTP_NO_CONTENT with and in the header a value 'X-Upload-Location':$SOME_URL.
The calling app needs to save $SOME_URL to send the raw file data to it using PUT.
After the upload is complete, the file is virus scanned and "content" / "virus_scan" data (GET/LIST only) are added to the resource.
In short, you do not find the document by asking 'API/material_lot/$SOME_ID' for a document, instead you search in API/document/ for objects with the right related_table / related_uuid.
List all documents.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The date at which the document was replaced |
content | string |
The URL of the document if one has been uploaded. |
created | iso-8601 datetime |
The date the document was created. |
name | string |
The filename of the document. |
previous_document | URI |
URI of a document that this document replaced |
previous_documents | array |
List of document URIs of all earlier documents (that were replaced on a certain resource).Sorted from most recently replaced document to the oldest replaced document. Example: '["..."]'
|
related_table_name | string |
The resource (related table name), for which should be uploaded the document. Choices
'"bureau_branding|line_item|order|run|work_instruction_report|material|model_library|order_packing_slip|material_batch|material_batch_action|material_lot|shipment|material_test_instruction_report"'
|
related_uuid | uuid |
The UUID of the resource (related table), for which should be uploaded the document. |
snapshot | string |
none available |
snapshot_content | string |
none available |
upload_location | string |
The upload URL of the document. This will be empty if a thumbnail has been uploaded. |
uri | URI |
The URI of the document. |
user | URI |
The URI of the user who created the document. |
virus_scan | string |
Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected. Choices
'"unscanned|passed|quarantined"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested document cannot be found. |
Create a new document.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The date at which the document was replaced Required |
content | string |
The URL of the document if one has been uploaded. Required |
created | iso-8601 datetime |
The date the document was created. Default: None |
name | string |
The filename of the document. Required |
previous_document | URI |
URI of a document that this document replaced Required |
previous_documents | array |
List of document URIs of all earlier documents (that were replaced on a certain resource).Sorted from most recently replaced document to the oldest replaced document. Default: [] Example: '["..."]'
|
related_table_name | string |
The resource (related table name), for which should be uploaded the document. Required Choices
'"bureau_branding|line_item|order|run|work_instruction_report|material|model_library|order_packing_slip|material_batch|material_batch_action|material_lot|shipment|material_test_instruction_report"'
|
related_uuid | uuid |
The UUID of the resource (related table), for which should be uploaded the document. Required |
snapshot | string |
none available Default: None |
snapshot_content | string |
none available Default: None |
upload_location | string |
The upload URL of the document. This will be empty if a thumbnail has been uploaded. Required |
uri | URI |
The URI of the document. Required |
user | URI |
The URI of the user who created the document. Required |
virus_scan | string |
Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected. Default: unscanned Choices
'"unscanned|passed|quarantined"'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested document cannot be found. |
/document//snapshot/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
none available |
created | iso-8601 datetime |
none available |
document | URI |
none available |
height | integer |
none available |
status | string |
none available Choices
'"not-uploaded|document-error|document-external-process|snapshot-in-queue|snapshot-rendering|snapshot-error|processing|complete|skipped"'
|
uri | URI |
none available |
width | integer |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
none available Default: None |
created | iso-8601 datetime |
none available Default: None |
document | URI |
none available Default: None |
height | integer |
none available Default: 480 |
status | string |
none available Default: None Choices
'"not-uploaded|document-error|document-external-process|snapshot-in-queue|snapshot-rendering|snapshot-error|processing|complete|skipped"'
|
uri | URI |
none available Default: None |
width | integer |
none available Default: 640 |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
none available |
created | iso-8601 datetime |
none available |
document | URI |
none available |
height | integer |
none available |
status | string |
none available Choices
'"not-uploaded|document-error|document-external-process|snapshot-in-queue|snapshot-rendering|snapshot-error|processing|complete|skipped"'
|
uri | URI |
none available |
width | integer |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/document//replace/
This endpoint is used to replace a document related to a certain resource. POST to this endpoint will create a new document resource, return x-upload-location as done in regular document POST, and archive the source document
Schema (application/json)
Property | Type | Description |
---|---|---|
name | string |
The name of the document. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested document cannot be found. |
Documents are a special resource. This is to track and upload files of (many)
kinds and link them to another resource. Instead of adding document
all over
the API, we have one document endpoint that tracks 'related_resource/uuid' of
what it is attached to.
POST to this endpoint to create a new promise of a document. On success, the promise replies with an OK in the reply's X-Upload-Location header. Use the X-Upload-location header to stream the raw contents of the file via PUT.
Example: User has a PDF file they want to attach to a material. They POST to this endpoint with:
{ "related_table_name": 'material', "related_uuid":UUID, ... }
If accepted, the caller receives a reply HTTP_NO_CONTENT with and in the header a value 'X-Upload-Location':$SOME_URL.
The calling app needs to save $SOME_URL to send the raw file data to it using PUT.
After the upload is complete, the file is virus scanned and "content" / "virus_scan" data (GET/LIST only) are added to the resource.
In short, you do not find the document by asking 'API/material_lot/$SOME_ID' for a document, instead you search in API/document/ for objects with the right related_table / related_uuid.
Get an document by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The date at which the document was replaced |
content | string |
The URL of the document if one has been uploaded. |
created | iso-8601 datetime |
The date the document was created. |
name | string |
The filename of the document. |
previous_document | URI |
URI of a document that this document replaced |
previous_documents | array |
List of document URIs of all earlier documents (that were replaced on a certain resource).Sorted from most recently replaced document to the oldest replaced document. Example: '["..."]'
|
related_table_name | string |
The resource (related table name), for which should be uploaded the document. Choices
'"bureau_branding|line_item|order|run|work_instruction_report|material|model_library|order_packing_slip|material_batch|material_batch_action|material_lot|shipment|material_test_instruction_report"'
|
related_uuid | uuid |
The UUID of the resource (related table), for which should be uploaded the document. |
snapshot | string |
none available |
snapshot_content | string |
none available |
upload_location | string |
The upload URL of the document. This will be empty if a thumbnail has been uploaded. |
uri | URI |
The URI of the document. |
user | URI |
The URI of the user who created the document. |
virus_scan | string |
Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected. Choices
'"unscanned|passed|quarantined"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested document cannot be found. |
/downtime/
Downtime resource will help block a particular machine for a period of time. The machine can be any of of printer, post processor or shipping. Once the machine is blocked, no prints can be executed in that period of time for the machine. This helps block a machine for any purpose like maintenance or similar.
Get all downtime resources for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the downtime. Example: '"downtime for Maintenance"'
|
finish | iso-8601 datetime |
The estimated finish date of Machine downtime. |
post_processor | URI |
The URI of the post-processor for which we have to downtime. |
printer | URI |
The URI of the printer for which we have to downtime. |
shipping | URI |
The URI of the shipping for which we have to downtime. |
start | iso-8601 datetime |
The estimated start date of Machine downtime. |
uri | URI |
The URI for downtime resource. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested downtime name already exists. |
404 |
The requested downtime cannot be found. |
Create a new downtime resource.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the downtime. Required Example: '"downtime for Maintenance"'
|
finish | iso-8601 datetime |
The estimated finish date of Machine downtime. Required |
post_processor | URI |
The URI of the post-processor for which we have to downtime. Default: None |
printer | URI |
The URI of the printer for which we have to downtime. Default: None |
shipping | URI |
The URI of the shipping for which we have to downtime. Default: None |
start | iso-8601 datetime |
The estimated start date of Machine downtime. Required |
uri | URI |
The URI for downtime resource. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested downtime name already exists. |
404 |
The requested downtime cannot be found. |
Downtime resource will help block a particular machine for a period of time. The machine can be any of of printer, post processor or shipping. Once the machine is blocked, no prints can be executed in that period of time for the machine. This helps block a machine for any purpose like maintenance or similar.
Get an individual downtime resource by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the downtime. Example: '"downtime for Maintenance"'
|
finish | iso-8601 datetime |
The estimated finish date of Machine downtime. |
post_processor | URI |
The URI of the post-processor for which we have to downtime. |
printer | URI |
The URI of the printer for which we have to downtime. |
shipping | URI |
The URI of the shipping for which we have to downtime. |
start | iso-8601 datetime |
The estimated start date of Machine downtime. |
uri | URI |
The URI for downtime resource. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested downtime name already exists. |
404 |
The requested downtime cannot be found. |
/ecco/
This endpoint gathers data about ecco installations
Schema (application/json)
Property | Type | Description |
---|---|---|
os_architecture | string |
The operating system architecture Required |
os_name | string |
The operating system name Required |
os_version | string |
The operating system version Required |
uuid | string |
The UUID of the ecco installation Required |
version | string |
The version of ecco Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
/ecco/{uuid}/
This endpoint gathers data about ecco installations
Schema (application/json)
Property | Type | Description |
---|---|---|
os_architecture | string |
The operating system architecture |
os_name | string |
The operating system name |
os_version | string |
The operating system version |
uuid | string |
The UUID of the ecco installation |
version | string |
The version of ecco |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/emailreport/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
/event/
The Event API contains information about events that have occurred in the system. This may include orders being processed, prints being created printers that need servicing, etc. Events are recorded for nearly every change in the system and do not expire
List all of the events in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. |
created | iso-8601 datetime |
The date the event was created. |
current_value | anything |
The new value after the change has completed |
key | string |
none available |
previous_value | anything |
The old value before the change took place |
reference | URL |
The URI of the resource that changed |
uri | URI |
The URI of the event. |
user | URI |
The user that made the change |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested event cannot be found. |
/event/{uuid}/
The Event API contains information about events that have occurred in the system. This may include orders being processed, prints being created printers that need servicing, etc. Events are recorded for nearly every change in the system and do not expire
Get a single event by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. |
created | iso-8601 datetime |
The date the event was created. |
current_value | anything |
The new value after the change has completed |
key | string |
none available |
previous_value | anything |
The old value before the change took place |
reference | URL |
The URI of the resource that changed |
uri | URI |
The URI of the event. |
user | URI |
The user that made the change |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested event cannot be found. |
/external-estimate/
This is the resource for estimating material, and time usage for a print
Schema (application/json)
Property | Type | Description |
---|---|---|
base_material_usage | float |
cm^3 base material used Default: None Example: '"42.0"'
|
callback | object |
Callback URL for price quoting result Default: None Example: '{}'
|
error | string |
Error message from estimation process Default: None Example: '"Failed to grab model data"'
|
layer_change_speed | float |
seconds it takes the printer to start the next layer after it has finished the previous Default: 2.0 Example: '"6.5"'
|
model | URI |
This URL should point to a valid model resource that has already been uploaded. Required Example: '"https://models.authentise.com/model/456/"'
|
print_time | integer |
Estimated print time in seconds Default: None Example: '"8766"'
|
status | string |
Status code of the request. Possible status are: complete, error, processing, queued. Default: None Example: '"complete"'
|
support_material_usage | float |
cm^3 support material used Default: None Example: '"42.0"'
|
uri | URI |
The URI of the /estimate/ instance Default: None Example: '"https://quoting.authentise.com/estimate/123456/"'
|
volume_per_second | float |
mm^3 material deposited per second Default: 30 Example: '"42.0"'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is the resource for estimating material, and time usage for a print
Schema (application/json)
Property | Type | Description |
---|---|---|
base_material_usage | float |
cm^3 base material used Example: '"42.0"'
|
callback | object |
Callback URL for price quoting result Example: '{}'
|
error | string |
Error message from estimation process Example: '"Failed to grab model data"'
|
layer_change_speed | float |
seconds it takes the printer to start the next layer after it has finished the previous Example: '"6.5"'
|
model | URI |
This URL should point to a valid model resource that has already been uploaded. Example: '"https://models.authentise.com/model/456/"'
|
print_time | integer |
Estimated print time in seconds Example: '"8766"'
|
status | string |
Status code of the request. Possible status are: complete, error, processing, queued. Example: '"complete"'
|
support_material_usage | float |
cm^3 support material used Example: '"42.0"'
|
uri | URI |
The URI of the /estimate/ instance Example: '"https://quoting.authentise.com/estimate/123456/"'
|
volume_per_second | float |
mm^3 material deposited per second Example: '"42.0"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/feature/
The feature API is for Authentise to control access to features. Ordinary users can only view features, not change them either through POST or PUT or DELETE
List all of the features in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau affected by the feature setting. |
description | string |
The description of the feature. |
enabled | boolean |
Whether or not the feature is enabled |
name | string |
The name of the feature. Choices
'"ip-sensitivity|no_model_upload|order-customer-po|order-quote-number|order-sales-representative|order-order-owner|order-documents|eos-order-fields|fastradius-order-fields|henkel-order-fields|voestalpine-order-fields|sintavia-order-fields|design-cost|netfabb|traveler|quoting|order-business-segment|order-order-type|service-providers|self-registration-allowed|manufacturing-execution-system|machine-analytics|external_production_estimate|recalculation_trigger|qr-prints-traveler|order-quote|user-can-update-estimates|model-unit-default-mm|specimen-library|model-library|auto-schedule-runs|use_100_infill|autorun|autologout|external-material-db|restricted-user-upload-from-model-library-only|merck-order-fields|line-item-extended-details|boeing-order-fields|3M-main-bureau-order-fields|3M-aqua-order-fields|order-packing-slip|oerlikon-order-fields|line-item-work-step-quote-details|order-quote-available-for-restricted|material-management|priority|user-run-time-tracking|run-time-tracking|service-provider-at-steps|gkn-powderbed-order-fields|order-location|prep-workflow|order-due-date|ricoh-reason-code|hawking-deployment|beehive3d-order-fields|native-cad-to-stl-conversion|anatomical-model|group-qualifications|shipment-for-order|shipment-packing-slip|integration-zverse|general-mfg-language|xerox-3dp-production-order-fields|authentise-pdm|nebumind|mesh-healing|3dpc-order-fields|stanley-x-deployment|threads-integration|rules-engine|certified-builds|build-file-library|work-schedule|workstep-estimate|material-test-panel|wip-matrix|digital-design-warehouse|pack3d-premium|additive-workflow|powder-workflow|carpenter-powder|msnav-importer|roboze-ddw|amazon-order-fields|sensors|payment-system|integration-castor|integration-stripe"'
|
uri | URI |
The URI of the feature. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested feature name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested feature cannot be found. |
Create a new feature.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau affected by the feature setting. Default: None |
description | string |
The description of the feature. Default: None |
enabled | boolean |
Whether or not the feature is enabled Required |
name | string |
The name of the feature. Required Choices
'"ip-sensitivity|no_model_upload|order-customer-po|order-quote-number|order-sales-representative|order-order-owner|order-documents|eos-order-fields|fastradius-order-fields|henkel-order-fields|voestalpine-order-fields|sintavia-order-fields|design-cost|netfabb|traveler|quoting|order-business-segment|order-order-type|service-providers|self-registration-allowed|manufacturing-execution-system|machine-analytics|external_production_estimate|recalculation_trigger|qr-prints-traveler|order-quote|user-can-update-estimates|model-unit-default-mm|specimen-library|model-library|auto-schedule-runs|use_100_infill|autorun|autologout|external-material-db|restricted-user-upload-from-model-library-only|merck-order-fields|line-item-extended-details|boeing-order-fields|3M-main-bureau-order-fields|3M-aqua-order-fields|order-packing-slip|oerlikon-order-fields|line-item-work-step-quote-details|order-quote-available-for-restricted|material-management|priority|user-run-time-tracking|run-time-tracking|service-provider-at-steps|gkn-powderbed-order-fields|order-location|prep-workflow|order-due-date|ricoh-reason-code|hawking-deployment|beehive3d-order-fields|native-cad-to-stl-conversion|anatomical-model|group-qualifications|shipment-for-order|shipment-packing-slip|integration-zverse|general-mfg-language|xerox-3dp-production-order-fields|authentise-pdm|nebumind|mesh-healing|3dpc-order-fields|stanley-x-deployment|threads-integration|rules-engine|certified-builds|build-file-library|work-schedule|workstep-estimate|material-test-panel|wip-matrix|digital-design-warehouse|pack3d-premium|additive-workflow|powder-workflow|carpenter-powder|msnav-importer|roboze-ddw|amazon-order-fields|sensors|payment-system|integration-castor|integration-stripe"'
|
uri | URI |
The URI of the feature. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested feature name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested feature cannot be found. |
/feature/{uuid}/
The feature API is for Authentise to control access to features. Ordinary users can only view features, not change them either through POST or PUT or DELETE
Get a single feature by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau affected by the feature setting. |
description | string |
The description of the feature. |
enabled | boolean |
Whether or not the feature is enabled |
name | string |
The name of the feature. Choices
'"ip-sensitivity|no_model_upload|order-customer-po|order-quote-number|order-sales-representative|order-order-owner|order-documents|eos-order-fields|fastradius-order-fields|henkel-order-fields|voestalpine-order-fields|sintavia-order-fields|design-cost|netfabb|traveler|quoting|order-business-segment|order-order-type|service-providers|self-registration-allowed|manufacturing-execution-system|machine-analytics|external_production_estimate|recalculation_trigger|qr-prints-traveler|order-quote|user-can-update-estimates|model-unit-default-mm|specimen-library|model-library|auto-schedule-runs|use_100_infill|autorun|autologout|external-material-db|restricted-user-upload-from-model-library-only|merck-order-fields|line-item-extended-details|boeing-order-fields|3M-main-bureau-order-fields|3M-aqua-order-fields|order-packing-slip|oerlikon-order-fields|line-item-work-step-quote-details|order-quote-available-for-restricted|material-management|priority|user-run-time-tracking|run-time-tracking|service-provider-at-steps|gkn-powderbed-order-fields|order-location|prep-workflow|order-due-date|ricoh-reason-code|hawking-deployment|beehive3d-order-fields|native-cad-to-stl-conversion|anatomical-model|group-qualifications|shipment-for-order|shipment-packing-slip|integration-zverse|general-mfg-language|xerox-3dp-production-order-fields|authentise-pdm|nebumind|mesh-healing|3dpc-order-fields|stanley-x-deployment|threads-integration|rules-engine|certified-builds|build-file-library|work-schedule|workstep-estimate|material-test-panel|wip-matrix|digital-design-warehouse|pack3d-premium|additive-workflow|powder-workflow|carpenter-powder|msnav-importer|roboze-ddw|amazon-order-fields|sensors|payment-system|integration-castor|integration-stripe"'
|
uri | URI |
The URI of the feature. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested feature name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested feature cannot be found. |
/file/
Endpoint for internal storage of data
GET LIST. This only works for internal users.
Schema (application/json)
Property | Type | Description |
---|---|---|
bucket | string |
none available |
content | string |
none available |
description | string |
none available |
key | string |
none available |
mimetype | string |
none available |
name | string |
none available |
upload-location | string |
none available |
uploaded | iso-8601 datetime |
none available |
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
bucket | string |
none available Required |
content | string |
none available Required |
description | string |
none available Default: None |
key | string |
none available Required |
mimetype | string |
none available Required |
name | string |
none available Default: None |
upload-location | string |
none available Required |
uploaded | iso-8601 datetime |
none available Required |
uri | URI |
none available Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
404 |
|
/file/{uuid}/
Endpoint for internal storage of data
Schema (application/json)
Property | Type | Description |
---|---|---|
bucket | string |
none available |
content | string |
none available |
description | string |
none available |
key | string |
none available |
mimetype | string |
none available |
name | string |
none available |
upload-location | string |
none available |
uploaded | iso-8601 datetime |
none available |
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
|
/flat-line-item/
Returns Flat Line Item object Used generally for Microsoft Flow
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_costs | array |
A list of manually added additional costs. Example: '[{}]'
|
anatomy_element | string |
The name of the anatomy element of the line_item. |
anatomy_family | string |
The name of the anatomy family of the line_item. |
anatomy_property | string |
The name of the anatomy property of the line_item. |
application_type | string |
Application type of the Line Item's order. |
base_material_name | string |
The name of base material. |
base_material_used | float |
Estimated amount of base material used in cc. |
bureau_custom_cost | float |
Estimated bureau cost. |
business_location | string |
The name of the business location of the line_item's order. |
business_segment | string |
The name of the business segment of the line_item's order. |
business_unit | string |
The name of the business unit of the line_item's order. |
completed_date | iso-8601 datetime |
Date when Line Item's order was marked as completed |
confirmed_date | string |
Order Confirmed Date |
cost_center | string |
The name of the cost_center of the line_item's order. |
cpt_code | string |
The name of the CPT Code of the line_item. |
currency | string |
The currency of the line-item, based on the bureau default currency. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
custom_field_values | array |
none available Example: '[{"custom_field_id": "c|u|s|t|o|m|-|f|i|e|l|d"}]'
|
customer_email | string |
The customer email address for the Line Item's order. |
customer_name | string |
The customer name for the Line Item's order. |
customer_requested_delivery | string |
Order Customer Requested Delivery Date |
customer_target_price | string |
Order Customer Target Price |
department_number | string |
Order Department Number |
design_time | integer |
Time which can take bureau for design review in seconds. |
division_name | string |
Order Division Name |
due_date | iso-8601 datetime |
The due date for the Line Item's order. |
ip_sensitivity | string |
The intellectual property sensitivity of the Line Item's order. Choices
'"high|medium|low"'
|
ipt | string |
Order IPT |
layer_thickness | float |
The layer thickness of the print in mm. Must be < 1. |
location | string |
Name of the Line Item's order location. |
manufacturing_process | string |
Line Item Manufacturing Process |
material_cost | float |
Estimated cost for base and support materials, scaled using line item's quantity and order's currency. |
model | URL |
The URI for model. |
model_name | string |
The name of the line-item's model. |
model_render | URL |
The URI for line-item's render model. |
model_surface_area | float |
Model surface area. |
model_updated | iso-8601 datetime |
When the model was last updated. |
model_volume | float |
Model volume in mm^3 multiplied on the line-item's quantity. |
month | integer |
The month to fetch orders from. |
notes | string |
Notes for a line item. |
offered_service_provider_cost | float |
Cost of a negotiated with a service provider job. |
offered_service_provider_currency | string |
Currency for a cost for a negotiated with a service provider job. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
offered_service_provider_name | string |
Name of a service provider to which offered (negotiated+) a job. |
offered_service_provider_uuid | uuid |
UUID of a service provider to which offered (negotiated+) a job. |
order | uuid |
The UUID of order the line-item belongs to. |
order_created_by | string |
Formatted name of user that created order. |
order_customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. |
order_date | iso-8601 datetime |
Date when the order was created. |
part_intended_use | string |
The name of the Part Intended Use for the line_item. |
post_processing_cost | float |
Estimated post processing costs. |
print_bounding_box | float |
Model's bounding box size in mm^3: multiplied X, Y, and Z. |
printer_type_name | string |
The name of the Printer Type for the workflow's printing process step. |
prints_quantity | integer |
Prints Quantity. |
priority_type | string |
Order Priority Type |
production_type | string |
Order Production Type |
request_type | string |
Order Request Type |
revision | string |
The name of the Revision for the line_item. |
status | string |
Status of an line-item. |
support_material_name | string |
The name of support material. |
support_material_used | float |
Estimated amount of support material used in cc. |
uri | URI |
The URI of the line-item. |
uuid | uuid |
The UUID of the line-item. |
workflow_name | string |
The name of workflow. |
year | integer |
The year to fetch orders from |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_costs | array |
A list of manually added additional costs. Required Example: '[{}]'
|
anatomy_element | string |
The name of the anatomy element of the line_item. Default: None |
anatomy_family | string |
The name of the anatomy family of the line_item. Default: None |
anatomy_property | string |
The name of the anatomy property of the line_item. Default: None |
application_type | string |
Application type of the Line Item's order. Required |
base_material_name | string |
The name of base material. Required |
base_material_used | float |
Estimated amount of base material used in cc. Required |
bureau_custom_cost | float |
Estimated bureau cost. Required |
business_location | string |
The name of the business location of the line_item's order. Default: None |
business_segment | string |
The name of the business segment of the line_item's order. Default: None |
business_unit | string |
The name of the business unit of the line_item's order. Default: None |
completed_date | iso-8601 datetime |
Date when Line Item's order was marked as completed Required |
confirmed_date | string |
Order Confirmed Date Required |
cost_center | string |
The name of the cost_center of the line_item's order. Default: None |
cpt_code | string |
The name of the CPT Code of the line_item. Default: None |
currency | string |
The currency of the line-item, based on the bureau default currency. Required Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
custom_field_values | array |
none available Default: None Example: '[{"custom_field_id": "c|u|s|t|o|m|-|f|i|e|l|d"}]'
|
customer_email | string |
The customer email address for the Line Item's order. Required |
customer_name | string |
The customer name for the Line Item's order. Required |
customer_requested_delivery | string |
Order Customer Requested Delivery Date Required |
customer_target_price | string |
Order Customer Target Price Required |
department_number | string |
Order Department Number Required |
design_time | integer |
Time which can take bureau for design review in seconds. Required |
division_name | string |
Order Division Name Required |
due_date | iso-8601 datetime |
The due date for the Line Item's order. Required |
ip_sensitivity | string |
The intellectual property sensitivity of the Line Item's order. Required Choices
'"high|medium|low"'
|
ipt | string |
Order IPT Required |
layer_thickness | float |
The layer thickness of the print in mm. Must be < 1. Required |
location | string |
Name of the Line Item's order location. Required |
manufacturing_process | string |
Line Item Manufacturing Process Required |
material_cost | float |
Estimated cost for base and support materials, scaled using line item's quantity and order's currency. Required |
model | URL |
The URI for model. Required |
model_name | string |
The name of the line-item's model. Required |
model_render | URL |
The URI for line-item's render model. Required |
model_surface_area | float |
Model surface area. Required |
model_updated | iso-8601 datetime |
When the model was last updated. Required |
model_volume | float |
Model volume in mm^3 multiplied on the line-item's quantity. Required |
month | integer |
The month to fetch orders from. Default: None |
notes | string |
Notes for a line item. Required |
offered_service_provider_cost | float |
Cost of a negotiated with a service provider job. Required |
offered_service_provider_currency | string |
Currency for a cost for a negotiated with a service provider job. Required Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
offered_service_provider_name | string |
Name of a service provider to which offered (negotiated+) a job. Required |
offered_service_provider_uuid | uuid |
UUID of a service provider to which offered (negotiated+) a job. Required |
order | uuid |
The UUID of order the line-item belongs to. Required |
order_created_by | string |
Formatted name of user that created order. Required |
order_customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. Required |
order_date | iso-8601 datetime |
Date when the order was created. Required |
part_intended_use | string |
The name of the Part Intended Use for the line_item. Default: None |
post_processing_cost | float |
Estimated post processing costs. Required |
print_bounding_box | float |
Model's bounding box size in mm^3: multiplied X, Y, and Z. Default: False |
printer_type_name | string |
The name of the Printer Type for the workflow's printing process step. Required |
prints_quantity | integer |
Prints Quantity. Required |
priority_type | string |
Order Priority Type Required |
production_type | string |
Order Production Type Required |
request_type | string |
Order Request Type Required |
revision | string |
The name of the Revision for the line_item. Default: None |
status | string |
Status of an line-item. Required |
support_material_name | string |
The name of support material. Required |
support_material_used | float |
Estimated amount of support material used in cc. Required |
uri | URI |
The URI of the line-item. Required |
uuid | uuid |
The UUID of the line-item. Required |
workflow_name | string |
The name of workflow. Required |
year | integer |
The year to fetch orders from Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
Returns Flat Line Item object Used generally for Microsoft Flow
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_costs | array |
A list of manually added additional costs. Example: '[{}]'
|
anatomy_element | string |
The name of the anatomy element of the line_item. |
anatomy_family | string |
The name of the anatomy family of the line_item. |
anatomy_property | string |
The name of the anatomy property of the line_item. |
application_type | string |
Application type of the Line Item's order. |
base_material_name | string |
The name of base material. |
base_material_used | float |
Estimated amount of base material used in cc. |
bureau_custom_cost | float |
Estimated bureau cost. |
business_location | string |
The name of the business location of the line_item's order. |
business_segment | string |
The name of the business segment of the line_item's order. |
business_unit | string |
The name of the business unit of the line_item's order. |
completed_date | iso-8601 datetime |
Date when Line Item's order was marked as completed |
confirmed_date | string |
Order Confirmed Date |
cost_center | string |
The name of the cost_center of the line_item's order. |
cpt_code | string |
The name of the CPT Code of the line_item. |
currency | string |
The currency of the line-item, based on the bureau default currency. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
custom_field_values | array |
none available Example: '[{"custom_field_id": "c|u|s|t|o|m|-|f|i|e|l|d"}]'
|
customer_email | string |
The customer email address for the Line Item's order. |
customer_name | string |
The customer name for the Line Item's order. |
customer_requested_delivery | string |
Order Customer Requested Delivery Date |
customer_target_price | string |
Order Customer Target Price |
department_number | string |
Order Department Number |
design_time | integer |
Time which can take bureau for design review in seconds. |
division_name | string |
Order Division Name |
due_date | iso-8601 datetime |
The due date for the Line Item's order. |
ip_sensitivity | string |
The intellectual property sensitivity of the Line Item's order. Choices
'"high|medium|low"'
|
ipt | string |
Order IPT |
layer_thickness | float |
The layer thickness of the print in mm. Must be < 1. |
location | string |
Name of the Line Item's order location. |
manufacturing_process | string |
Line Item Manufacturing Process |
material_cost | float |
Estimated cost for base and support materials, scaled using line item's quantity and order's currency. |
model | URL |
The URI for model. |
model_name | string |
The name of the line-item's model. |
model_render | URL |
The URI for line-item's render model. |
model_surface_area | float |
Model surface area. |
model_updated | iso-8601 datetime |
When the model was last updated. |
model_volume | float |
Model volume in mm^3 multiplied on the line-item's quantity. |
month | integer |
The month to fetch orders from. |
notes | string |
Notes for a line item. |
offered_service_provider_cost | float |
Cost of a negotiated with a service provider job. |
offered_service_provider_currency | string |
Currency for a cost for a negotiated with a service provider job. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
offered_service_provider_name | string |
Name of a service provider to which offered (negotiated+) a job. |
offered_service_provider_uuid | uuid |
UUID of a service provider to which offered (negotiated+) a job. |
order | uuid |
The UUID of order the line-item belongs to. |
order_created_by | string |
Formatted name of user that created order. |
order_customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. |
order_date | iso-8601 datetime |
Date when the order was created. |
part_intended_use | string |
The name of the Part Intended Use for the line_item. |
post_processing_cost | float |
Estimated post processing costs. |
print_bounding_box | float |
Model's bounding box size in mm^3: multiplied X, Y, and Z. |
printer_type_name | string |
The name of the Printer Type for the workflow's printing process step. |
prints_quantity | integer |
Prints Quantity. |
priority_type | string |
Order Priority Type |
production_type | string |
Order Production Type |
request_type | string |
Order Request Type |
revision | string |
The name of the Revision for the line_item. |
status | string |
Status of an line-item. |
support_material_name | string |
The name of support material. |
support_material_used | float |
Estimated amount of support material used in cc. |
uri | URI |
The URI of the line-item. |
uuid | uuid |
The UUID of the line-item. |
workflow_name | string |
The name of workflow. |
year | integer |
The year to fetch orders from |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Base class for special endpoint to review delivery data on materials, for monthly/yearly business review needs.
Built to search on 'Purchase Order ID' (not UUID, but customer ID - material_purchase_order.external_id) and material_lot UUID.
Children classes will only defined "ENDPOINT" class variable and will extend "list" method.
Schema (application/json)
Property | Type | Description |
---|---|---|
delivery_date | iso-8601 datetime |
Datetime when the material lot was received. |
delivery_id | string |
Customer ID of the delivery |
location_name | string |
Location name to which pinned the material lot. |
material_name | string |
Name of the material in the material lot. |
notes | string |
Custom user description/notes for receiving a material lot. |
po | string |
Purchase order ID (format customer defined). |
status | string |
none available Choices
'"received|on_order"'
|
user_name | string |
Name of a user who marked the lot as received or who created the material lot. |
uuid | uuid |
Material Lot UUID. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
delivery_date | iso-8601 datetime |
Datetime when the material lot was received. Required |
delivery_id | string |
Customer ID of the delivery Required |
location_name | string |
Location name to which pinned the material lot. Required |
material_name | string |
Name of the material in the material lot. Required |
notes | string |
Custom user description/notes for receiving a material lot. Required |
po | string |
Purchase order ID (format customer defined). Required |
status | string |
none available Required Choices
'"received|on_order"'
|
user_name | string |
Name of a user who marked the lot as received or who created the material lot. Required |
uuid | uuid |
Material Lot UUID. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
Base class for special endpoint to review delivery data on materials, for monthly/yearly business review needs.
Built to search on 'Purchase Order ID' (not UUID, but customer ID - material_purchase_order.external_id) and material_lot UUID.
Children classes will only defined "ENDPOINT" class variable and will extend "list" method.
Schema (application/json)
Property | Type | Description |
---|---|---|
delivery_date | iso-8601 datetime |
Datetime when the material lot was received. |
delivery_id | string |
Customer ID of the delivery |
location_name | string |
Location name to which pinned the material lot. |
material_name | string |
Name of the material in the material lot. |
notes | string |
Custom user description/notes for receiving a material lot. |
po | string |
Purchase order ID (format customer defined). |
status | string |
none available Choices
'"received|on_order"'
|
user_name | string |
Name of a user who marked the lot as received or who created the material lot. |
uuid | uuid |
Material Lot UUID. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Base class for special endpoint to review delivery data on materials, for monthly/yearly business review needs.
Built to search on 'Purchase Order ID' (not UUID, but customer ID - material_purchase_order.external_id) and material_lot UUID.
Children classes will only defined "ENDPOINT" class variable and will extend "list" method.
Schema (application/json)
Property | Type | Description |
---|---|---|
delivery_date | iso-8601 datetime |
Datetime when the material lot was received. |
delivery_id | string |
Customer ID of the delivery |
location_name | string |
Location name to which pinned the material lot. |
material_name | string |
Name of the material in the material lot. |
notes | string |
Custom user description/notes for receiving a material lot. |
po | string |
Purchase order ID (format customer defined). |
status | string |
none available Choices
'"received|on_order"'
|
user_name | string |
Name of a user who marked the lot as received or who created the material lot. |
uuid | uuid |
Material Lot UUID. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
delivery_date | iso-8601 datetime |
Datetime when the material lot was received. Required |
delivery_id | string |
Customer ID of the delivery Required |
location_name | string |
Location name to which pinned the material lot. Required |
material_name | string |
Name of the material in the material lot. Required |
notes | string |
Custom user description/notes for receiving a material lot. Required |
po | string |
Purchase order ID (format customer defined). Required |
status | string |
none available Required Choices
'"received|on_order"'
|
user_name | string |
Name of a user who marked the lot as received or who created the material lot. Required |
uuid | uuid |
Material Lot UUID. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
Base class for special endpoint to review delivery data on materials, for monthly/yearly business review needs.
Built to search on 'Purchase Order ID' (not UUID, but customer ID - material_purchase_order.external_id) and material_lot UUID.
Children classes will only defined "ENDPOINT" class variable and will extend "list" method.
Schema (application/json)
Property | Type | Description |
---|---|---|
delivery_date | iso-8601 datetime |
Datetime when the material lot was received. |
delivery_id | string |
Customer ID of the delivery |
location_name | string |
Location name to which pinned the material lot. |
material_name | string |
Name of the material in the material lot. |
notes | string |
Custom user description/notes for receiving a material lot. |
po | string |
Purchase order ID (format customer defined). |
status | string |
none available Choices
'"received|on_order"'
|
user_name | string |
Name of a user who marked the lot as received or who created the material lot. |
uuid | uuid |
Material Lot UUID. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/flat-order/
Returns Flat Order object Used generally for Microsoft Flow
Schema (application/json)
Property | Type | Description |
---|---|---|
activity_id | string |
Order Activity ID |
application_type | string |
Application Type. |
bill_to_address | string |
Order Bill to Address |
bill_to_name | string |
Order Bill to Name |
bill_to_phone_number | string |
Order Bill to Phone Number |
bureau_costs | float |
Estimated bureau costs. |
business_location | string |
Order Business Location name |
business_segment | string |
Order Business Segment name |
business_unit | string |
Order Business Unit name |
completed_date | iso-8601 datetime |
The latest 'completed' date from order's line items (all orders line_items must be completed, or at least one should be completed and all other be in 'error' or 'cancelled' statuses.). |
confirmed_date | string |
Order Confirmed Date |
cost_center | string |
Order Cost Center |
created | iso-8601 datetime |
The date the order was created. |
created_by | string |
Formatted name of user that created order. |
custom_field_values | array |
none available Example: '[{"custom_field_id": "c|u|s|t|o|m|-|f|i|e|l|d"}]'
|
customer_email | string |
Customer email address. |
customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. |
customer_name | string |
Customer name for the order. |
customer_requested_delivery | string |
Order Customer Requested Delivery Date |
customer_target_price | string |
Order Customer Target Price |
department_number | string |
Order Department Number |
division_name | string |
Order Division Name |
due_date | iso-8601 datetime |
The due date for the order. |
edp_code | string |
Order edp code |
erp_error_description | string |
Order ERP Error Description |
erp_id | string |
Order ERP ID |
erp_last_sync_datetime | string |
Order Last Sync Datetime string |
erp_reference_uri | string |
Order ERP Reference URI |
finance_review | string |
Order Finance Review |
funding_vehicle | string |
Order Funding Vehicle |
ip_sensitivity | string |
The intellectual property sensitivity. |
ipt | string |
Order IPT |
jira_ticket | string |
Order JIRA Ticket link |
line_items_quantity | integer |
Line Item Quantity. |
location | string |
Name of the location. |
material_cost | float |
Estimated material costs. |
name | string |
Name of the order. |
notes | string |
Notes for the order. |
oracle_id | string |
Order oracle id |
order_type | string |
Order type choices. Choice depends on the bureau. |
order_volume | integer |
Order volume. |
owner_email | string |
Email of the order owner. |
owner_name | string |
The name of the order owner. |
po_number | string |
Order PO Number |
portal_project_id | string |
Order Portal Project ID |
post_processing_cost | float |
Estimated bureau costs. |
prints_quantity | integer |
Prints Quantity. |
priority_type | string |
Order Priority Type |
process_workstream | string |
Order Process Workstream array |
product_line | string |
Order Product Line |
production_type | string |
Order Production Type |
quote_approved | boolean |
Is order quote accepted |
quote_created_at | string |
The date that the order quote was created. |
quote_customer_po | string |
PO for order quote. |
quote_discount | float |
Discount for quote |
quote_uri | string |
The URI of the order quote. |
request_type | string |
Order Request Type |
shipping_address | string |
Shipping address. |
shipping_cost | float |
Estimated shipping costs. |
shipping_name | string |
Shipping name. |
status | string |
Status of an order. |
total_order_material_usage | string |
Order total material; usage (cc) |
uri | URI |
The URI of the order. |
uuid | uuid |
The UUID of the order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
activity_id | string |
Order Activity ID Required |
application_type | string |
Application Type. Required |
bill_to_address | string |
Order Bill to Address Default: None |
bill_to_name | string |
Order Bill to Name Default: None |
bill_to_phone_number | string |
Order Bill to Phone Number Default: None |
bureau_costs | float |
Estimated bureau costs. Required |
business_location | string |
Order Business Location name Default: None |
business_segment | string |
Order Business Segment name Default: None |
business_unit | string |
Order Business Unit name Default: None |
completed_date | iso-8601 datetime |
The latest 'completed' date from order's line items (all orders line_items must be completed, or at least one should be completed and all other be in 'error' or 'cancelled' statuses.). Required |
confirmed_date | string |
Order Confirmed Date Required |
cost_center | string |
Order Cost Center Default: None |
created | iso-8601 datetime |
The date the order was created. Required |
created_by | string |
Formatted name of user that created order. Required |
custom_field_values | array |
none available Default: None Example: '[{"custom_field_id": "c|u|s|t|o|m|-|f|i|e|l|d"}]'
|
customer_email | string |
Customer email address. Required |
customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. Required |
customer_name | string |
Customer name for the order. Required |
customer_requested_delivery | string |
Order Customer Requested Delivery Date Required |
customer_target_price | string |
Order Customer Target Price Required |
department_number | string |
Order Department Number Required |
division_name | string |
Order Division Name Required |
due_date | iso-8601 datetime |
The due date for the order. Required |
edp_code | string |
Order edp code Default: None |
erp_error_description | string |
Order ERP Error Description Default: None |
erp_id | string |
Order ERP ID Default: None |
erp_last_sync_datetime | string |
Order Last Sync Datetime string Default: None |
erp_reference_uri | string |
Order ERP Reference URI Default: None |
finance_review | string |
Order Finance Review Required |
funding_vehicle | string |
Order Funding Vehicle Required |
ip_sensitivity | string |
The intellectual property sensitivity. Required |
ipt | string |
Order IPT Required |
jira_ticket | string |
Order JIRA Ticket link Default: None |
line_items_quantity | integer |
Line Item Quantity. Required |
location | string |
Name of the location. Required |
material_cost | float |
Estimated material costs. Required |
name | string |
Name of the order. Required |
notes | string |
Notes for the order. Required |
oracle_id | string |
Order oracle id Default: None |
order_type | string |
Order type choices. Choice depends on the bureau. Required |
order_volume | integer |
Order volume. Required |
owner_email | string |
Email of the order owner. Required |
owner_name | string |
The name of the order owner. Required |
po_number | string |
Order PO Number Default: None |
portal_project_id | string |
Order Portal Project ID Default: None |
post_processing_cost | float |
Estimated bureau costs. Required |
prints_quantity | integer |
Prints Quantity. Required |
priority_type | string |
Order Priority Type Required |
process_workstream | string |
Order Process Workstream array Default: None |
product_line | string |
Order Product Line Required |
production_type | string |
Order Production Type Required |
quote_approved | boolean |
Is order quote accepted Required |
quote_created_at | string |
The date that the order quote was created. Required |
quote_customer_po | string |
PO for order quote. Required |
quote_discount | float |
Discount for quote Required |
quote_uri | string |
The URI of the order quote. Required |
request_type | string |
Order Request Type Required |
shipping_address | string |
Shipping address. Required |
shipping_cost | float |
Estimated shipping costs. Required |
shipping_name | string |
Shipping name. Required |
status | string |
Status of an order. Required |
total_order_material_usage | string |
Order total material; usage (cc) Default: None |
uri | URI |
The URI of the order. Required |
uuid | uuid |
The UUID of the order. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
Returns Flat Order object Used generally for Microsoft Flow
Schema (application/json)
Property | Type | Description |
---|---|---|
activity_id | string |
Order Activity ID |
application_type | string |
Application Type. |
bill_to_address | string |
Order Bill to Address |
bill_to_name | string |
Order Bill to Name |
bill_to_phone_number | string |
Order Bill to Phone Number |
bureau_costs | float |
Estimated bureau costs. |
business_location | string |
Order Business Location name |
business_segment | string |
Order Business Segment name |
business_unit | string |
Order Business Unit name |
completed_date | iso-8601 datetime |
The latest 'completed' date from order's line items (all orders line_items must be completed, or at least one should be completed and all other be in 'error' or 'cancelled' statuses.). |
confirmed_date | string |
Order Confirmed Date |
cost_center | string |
Order Cost Center |
created | iso-8601 datetime |
The date the order was created. |
created_by | string |
Formatted name of user that created order. |
custom_field_values | array |
none available Example: '[{"custom_field_id": "c|u|s|t|o|m|-|f|i|e|l|d"}]'
|
customer_email | string |
Customer email address. |
customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. |
customer_name | string |
Customer name for the order. |
customer_requested_delivery | string |
Order Customer Requested Delivery Date |
customer_target_price | string |
Order Customer Target Price |
department_number | string |
Order Department Number |
division_name | string |
Order Division Name |
due_date | iso-8601 datetime |
The due date for the order. |
edp_code | string |
Order edp code |
erp_error_description | string |
Order ERP Error Description |
erp_id | string |
Order ERP ID |
erp_last_sync_datetime | string |
Order Last Sync Datetime string |
erp_reference_uri | string |
Order ERP Reference URI |
finance_review | string |
Order Finance Review |
funding_vehicle | string |
Order Funding Vehicle |
ip_sensitivity | string |
The intellectual property sensitivity. |
ipt | string |
Order IPT |
jira_ticket | string |
Order JIRA Ticket link |
line_items_quantity | integer |
Line Item Quantity. |
location | string |
Name of the location. |
material_cost | float |
Estimated material costs. |
name | string |
Name of the order. |
notes | string |
Notes for the order. |
oracle_id | string |
Order oracle id |
order_type | string |
Order type choices. Choice depends on the bureau. |
order_volume | integer |
Order volume. |
owner_email | string |
Email of the order owner. |
owner_name | string |
The name of the order owner. |
po_number | string |
Order PO Number |
portal_project_id | string |
Order Portal Project ID |
post_processing_cost | float |
Estimated bureau costs. |
prints_quantity | integer |
Prints Quantity. |
priority_type | string |
Order Priority Type |
process_workstream | string |
Order Process Workstream array |
product_line | string |
Order Product Line |
production_type | string |
Order Production Type |
quote_approved | boolean |
Is order quote accepted |
quote_created_at | string |
The date that the order quote was created. |
quote_customer_po | string |
PO for order quote. |
quote_discount | float |
Discount for quote |
quote_uri | string |
The URI of the order quote. |
request_type | string |
Order Request Type |
shipping_address | string |
Shipping address. |
shipping_cost | float |
Estimated shipping costs. |
shipping_name | string |
Shipping name. |
status | string |
Status of an order. |
total_order_material_usage | string |
Order total material; usage (cc) |
uri | URI |
The URI of the order. |
uuid | uuid |
The UUID of the order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/flat-piece/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
current_process_step_position | integer |
Step position in workflow. Example: '"2"'
|
current_process_step_run_name | string |
The name of the current run. |
current_process_step_run_uuid | uuid |
The UUID of the current run. |
current_process_step_status | string |
The status of the current run. |
current_process_step_workstation_name | string |
The name of the workstation where current run is assigned. |
current_work_instruction_description | string |
Work instruction description. |
current_work_instruction_position | integer |
Step position of the Work Instruction for the Print Work Checklist |
current_work_instruction_uuid | uuid |
The Work Instruction UUID. |
first_run_end | iso-8601 datetime |
Datetime when the first run was finished (run status changed to Complete) for a piece (This marks the end of 'printing'). |
first_run_start | iso-8601 datetime |
Datetime when the first run (ie. the first process step in a piece's workflow) was started (run status Queued -> In Progress) for a piece (this marks the start of 'Production'). |
line_item_name | string |
The name of the associated line_item. |
line_item_uuid | uuid |
The UUID of the associated line_item. |
order_customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. |
order_name | string |
The name of the associated line_item's order. |
order_uuid | uuid |
The UUID of the associated line_item's order. |
past_process_step_completion_date | iso-8601 datetime |
The datetime at which the most recently completed process_step was completed, in UTC. |
past_work_instruction_step_completion_date | iso-8601 datetime |
The datetime at which past work instruction was completed, in UTC. |
print_run_name | string |
The name of the associated printing run. |
print_run_uuid | uuid |
The UUID of the associated printing run. |
process_step_workstation_type_name | string |
The name of the workstation type where current run is assigned. |
process_step_workstation_type_uuid | string |
The UUID of the workstation type where current run is assigned. |
total_process_steps | integer |
Number of process steps in the associated line item workflow. |
total_work_instructions_in_current_process_step | integer |
Number of work instructions in the work checklist for the current process step. |
uuid | uuid |
The UUID of the piece. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
current_process_step_position | integer |
Step position in workflow. Required Example: '"2"'
|
current_process_step_run_name | string |
The name of the current run. Required |
current_process_step_run_uuid | uuid |
The UUID of the current run. Required |
current_process_step_status | string |
The status of the current run. Required |
current_process_step_workstation_name | string |
The name of the workstation where current run is assigned. Required |
current_work_instruction_description | string |
Work instruction description. Required |
current_work_instruction_position | integer |
Step position of the Work Instruction for the Print Work Checklist Required |
current_work_instruction_uuid | uuid |
The Work Instruction UUID. Required |
first_run_end | iso-8601 datetime |
Datetime when the first run was finished (run status changed to Complete) for a piece (This marks the end of 'printing'). Required |
first_run_start | iso-8601 datetime |
Datetime when the first run (ie. the first process step in a piece's workflow) was started (run status Queued -> In Progress) for a piece (this marks the start of 'Production'). Required |
line_item_name | string |
The name of the associated line_item. Required |
line_item_uuid | uuid |
The UUID of the associated line_item. Required |
order_customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. Required |
order_name | string |
The name of the associated line_item's order. Required |
order_uuid | uuid |
The UUID of the associated line_item's order. Required |
past_process_step_completion_date | iso-8601 datetime |
The datetime at which the most recently completed process_step was completed, in UTC. Required |
past_work_instruction_step_completion_date | iso-8601 datetime |
The datetime at which past work instruction was completed, in UTC. Required |
print_run_name | string |
The name of the associated printing run. Required |
print_run_uuid | uuid |
The UUID of the associated printing run. Required |
process_step_workstation_type_name | string |
The name of the workstation type where current run is assigned. Required |
process_step_workstation_type_uuid | string |
The UUID of the workstation type where current run is assigned. Required |
total_process_steps | integer |
Number of process steps in the associated line item workflow. Required |
total_work_instructions_in_current_process_step | integer |
Number of work instructions in the work checklist for the current process step. Required |
uuid | uuid |
The UUID of the piece. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
current_process_step_position | integer |
Step position in workflow. Example: '"2"'
|
current_process_step_run_name | string |
The name of the current run. |
current_process_step_run_uuid | uuid |
The UUID of the current run. |
current_process_step_status | string |
The status of the current run. |
current_process_step_workstation_name | string |
The name of the workstation where current run is assigned. |
current_work_instruction_description | string |
Work instruction description. |
current_work_instruction_position | integer |
Step position of the Work Instruction for the Print Work Checklist |
current_work_instruction_uuid | uuid |
The Work Instruction UUID. |
first_run_end | iso-8601 datetime |
Datetime when the first run was finished (run status changed to Complete) for a piece (This marks the end of 'printing'). |
first_run_start | iso-8601 datetime |
Datetime when the first run (ie. the first process step in a piece's workflow) was started (run status Queued -> In Progress) for a piece (this marks the start of 'Production'). |
line_item_name | string |
The name of the associated line_item. |
line_item_uuid | uuid |
The UUID of the associated line_item. |
order_customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. |
order_name | string |
The name of the associated line_item's order. |
order_uuid | uuid |
The UUID of the associated line_item's order. |
past_process_step_completion_date | iso-8601 datetime |
The datetime at which the most recently completed process_step was completed, in UTC. |
past_work_instruction_step_completion_date | iso-8601 datetime |
The datetime at which past work instruction was completed, in UTC. |
print_run_name | string |
The name of the associated printing run. |
print_run_uuid | uuid |
The UUID of the associated printing run. |
process_step_workstation_type_name | string |
The name of the workstation type where current run is assigned. |
process_step_workstation_type_uuid | string |
The UUID of the workstation type where current run is assigned. |
total_process_steps | integer |
Number of process steps in the associated line item workflow. |
total_work_instructions_in_current_process_step | integer |
Number of work instructions in the work checklist for the current process step. |
uuid | uuid |
The UUID of the piece. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/flat-summary-line-item-tasks/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
current_task_name | string |
The workflow task name (for the current preparation task record). |
current_task_position | integer |
The workflow task position in the preparation workflow, starts from 0 (for the current preparation task record). |
current_task_record_comments | array |
The array with all comments (as text) from oldest to newest. Example: '["..."]'
|
current_task_record_dwell_time | timedelta |
Time (in seconds) between end time (or current time, if not finished yet) and time, when current preparation task record was moved to 'queued' status. Not idempotent if the current task record not finished yet. |
current_task_record_in_progress_time | timedelta |
Time (in seconds), which spent while the current task record was in progress. Not idempotent if the current task record not finished yet. |
current_task_record_on_hold_time | timedelta |
Time (in seconds), which spent while the current task record was on hold. Not idempotent if the current task record not finished yet. |
current_task_record_status | string |
Status of the current preparation task record. Choices
'"new|queued|in-progress|on-hold|complete|skipped|cancelled"'
|
current_task_record_uuid | uuid |
The current preparation task record uuid. |
current_task_shortname | string |
The workflow task shortname (for the current preparation task record). |
current_task_user_group_name | string |
The workflow task name (for the current preparation task record). |
current_task_uuid | uuid |
The UUID of the current task (for the current preparation task record). |
line_item_name | string |
The name of the line_item. |
line_item_uuid | uuid |
The UUID of the line_item. |
order_customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. |
order_name | string |
The name of the associated order. |
order_uuid | uuid |
The UUID of the associated order. |
prep_workflow_first_task_record_complete | iso-8601 datetime |
The datetime at which the first preparation task record was completed, in UTC. |
prep_workflow_first_task_record_queued | iso-8601 datetime |
The datetime at which the first preparation task record was moved to 'queued' status, in UTC. |
prep_workflow_name | string |
The name of the associated preparation workflow. |
prep_workflow_record_uuid | uuid |
The UUID of the preparation workflow record (if exists). |
prep_workflow_total_tasks | integer |
Number of preparation tasks in the associated preparation workflow. |
prep_workflow_uuid | uuid |
The UUID of the preparation workflow. |
prior_task_record_completion_date | iso-8601 datetime |
The datetime at which the prior preparation task record was completed, in UTC. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
current_task_name | string |
The workflow task name (for the current preparation task record). Required |
current_task_position | integer |
The workflow task position in the preparation workflow, starts from 0 (for the current preparation task record). Required |
current_task_record_comments | array |
The array with all comments (as text) from oldest to newest. Required Example: '["..."]'
|
current_task_record_dwell_time | timedelta |
Time (in seconds) between end time (or current time, if not finished yet) and time, when current preparation task record was moved to 'queued' status. Not idempotent if the current task record not finished yet. Required |
current_task_record_in_progress_time | timedelta |
Time (in seconds), which spent while the current task record was in progress. Not idempotent if the current task record not finished yet. Required |
current_task_record_on_hold_time | timedelta |
Time (in seconds), which spent while the current task record was on hold. Not idempotent if the current task record not finished yet. Required |
current_task_record_status | string |
Status of the current preparation task record. Required Choices
'"new|queued|in-progress|on-hold|complete|skipped|cancelled"'
|
current_task_record_uuid | uuid |
The current preparation task record uuid. Required |
current_task_shortname | string |
The workflow task shortname (for the current preparation task record). Required |
current_task_user_group_name | string |
The workflow task name (for the current preparation task record). Required |
current_task_uuid | uuid |
The UUID of the current task (for the current preparation task record). Required |
line_item_name | string |
The name of the line_item. Required |
line_item_uuid | uuid |
The UUID of the line_item. Required |
order_customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. Required |
order_name | string |
The name of the associated order. Required |
order_uuid | uuid |
The UUID of the associated order. Required |
prep_workflow_first_task_record_complete | iso-8601 datetime |
The datetime at which the first preparation task record was completed, in UTC. Required |
prep_workflow_first_task_record_queued | iso-8601 datetime |
The datetime at which the first preparation task record was moved to 'queued' status, in UTC. Required |
prep_workflow_name | string |
The name of the associated preparation workflow. Required |
prep_workflow_record_uuid | uuid |
The UUID of the preparation workflow record (if exists). Required |
prep_workflow_total_tasks | integer |
Number of preparation tasks in the associated preparation workflow. Required |
prep_workflow_uuid | uuid |
The UUID of the preparation workflow. Required |
prior_task_record_completion_date | iso-8601 datetime |
The datetime at which the prior preparation task record was completed, in UTC. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
current_task_name | string |
The workflow task name (for the current preparation task record). |
current_task_position | integer |
The workflow task position in the preparation workflow, starts from 0 (for the current preparation task record). |
current_task_record_comments | array |
The array with all comments (as text) from oldest to newest. Example: '["..."]'
|
current_task_record_dwell_time | timedelta |
Time (in seconds) between end time (or current time, if not finished yet) and time, when current preparation task record was moved to 'queued' status. Not idempotent if the current task record not finished yet. |
current_task_record_in_progress_time | timedelta |
Time (in seconds), which spent while the current task record was in progress. Not idempotent if the current task record not finished yet. |
current_task_record_on_hold_time | timedelta |
Time (in seconds), which spent while the current task record was on hold. Not idempotent if the current task record not finished yet. |
current_task_record_status | string |
Status of the current preparation task record. Choices
'"new|queued|in-progress|on-hold|complete|skipped|cancelled"'
|
current_task_record_uuid | uuid |
The current preparation task record uuid. |
current_task_shortname | string |
The workflow task shortname (for the current preparation task record). |
current_task_user_group_name | string |
The workflow task name (for the current preparation task record). |
current_task_uuid | uuid |
The UUID of the current task (for the current preparation task record). |
line_item_name | string |
The name of the line_item. |
line_item_uuid | uuid |
The UUID of the line_item. |
order_customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID[:8]. |
order_name | string |
The name of the associated order. |
order_uuid | uuid |
The UUID of the associated order. |
prep_workflow_first_task_record_complete | iso-8601 datetime |
The datetime at which the first preparation task record was completed, in UTC. |
prep_workflow_first_task_record_queued | iso-8601 datetime |
The datetime at which the first preparation task record was moved to 'queued' status, in UTC. |
prep_workflow_name | string |
The name of the associated preparation workflow. |
prep_workflow_record_uuid | uuid |
The UUID of the preparation workflow record (if exists). |
prep_workflow_total_tasks | integer |
Number of preparation tasks in the associated preparation workflow. |
prep_workflow_uuid | uuid |
The UUID of the preparation workflow. |
prior_task_record_completion_date | iso-8601 datetime |
The datetime at which the prior preparation task record was completed, in UTC. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/gcode/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
none available |
error | object |
none available Example: '{}'
|
name | string |
none available |
rights | array |
none available Example: '["all|download|print|transform|transform-external|view"]'
|
status | string |
none available Choices
'"not-uploaded|processing|processed|error"'
|
uri | URI |
GCode URI |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
none available Default: None |
error | object |
none available Default: None Example: '{}'
|
name | string |
none available Required |
rights | array |
none available Default: None Example: '["all|download|print|transform|transform-external|view"]'
|
status | string |
none available Default: None Choices
'"not-uploaded|processing|processed|error"'
|
uri | URI |
GCode URI Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
|
404 |
|
/gcode/{uuid}/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | string |
none available |
error | object |
none available Example: '{}'
|
name | string |
none available |
rights | array |
none available Example: '["all|download|print|transform|transform-external|view"]'
|
status | string |
none available Choices
'"not-uploaded|processing|processed|error"'
|
uri | URI |
GCode URI |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
/groups/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
none available |
name | string |
none available |
secret | string |
none available |
subgroups | array |
none available Example: '["..."]'
|
uri | string |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
none available Required |
name | string |
none available Required |
secret | string |
none available Default: None |
subgroups | array |
none available Default: [] Example: '["..."]'
|
uri | string |
none available Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
/groups/{uuid}/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
none available |
name | string |
none available |
secret | string |
none available |
subgroups | array |
none available Example: '["..."]'
|
uri | string |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/guideline/comparator/
Stub Endpoint. Comparators describe the comparisons we can perform on a named_expressions in order to make an expression/condition. If these comparisons operation evaluate to true they will trigger guideline engine suggestions.
Example: IF “Workflow Step” is “EOS M290” AND “Line Item Field” “Material Type” is “Ti64” THEN suggest to add “Work Instruction Template 56” In this case, the 'IF' statements are comparator's
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the comparator belongs to. |
name | string |
Comparator type name. Choices
'"equals|greater_than|less_than|contains|before|after|on"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested comparator cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the comparator belongs to. Required |
name | string |
Comparator type name. Required Choices
'"equals|greater_than|less_than|contains|before|after|on"'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested comparator cannot be found. |
Stub Endpoint. Comparators describe the comparisons we can perform on a named_expressions in order to make an expression/condition. If these comparisons operation evaluate to true they will trigger guideline engine suggestions.
Example: IF “Workflow Step” is “EOS M290” AND “Line Item Field” “Material Type” is “Ti64” THEN suggest to add “Work Instruction Template 56” In this case, the 'IF' statements are comparator's
Get a single comparator by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the comparator belongs to. |
name | string |
Comparator type name. Choices
'"equals|greater_than|less_than|contains|before|after|on"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested comparator cannot be found. |
This endpoint serves the purpose of creating guideline expressions to be used by Production Guideline engine.
A guideline expression is a boolean test on internal data, with a simple name for a user to use/view/match.
This turns complex DB lookup into a API compatibible expression.
Example: IF “Workflow Step” is “EOS M290” AND “Line Item Field” “Material Type” is “Ti64” THEN suggest to add “Work Instruction Template 56”
In this example: 'Workflow Step' is our Guideline Expression. This is a series of DB look-up/join to find 'line-item['workflow'] => process_step, => 'process_step[workstation]' => workstation['type'] => printer_type['name'].
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau this guideline-expression belongs to. Required |
comparator | URI |
uri for the specific comparator to be used to evaluate the named_expression Required |
name | string |
Simple Human Readable display name of the expression Default: Unnamed Production Guideline Expression |
named_expression | URI |
named-expression uri to be evaluated. Required |
uri | URI |
The URI of the production guideline expression. Required |
value | string |
value to compare evaluated named_expression to Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This endpoint serves the purpose of creating guideline expressions to be used by Production Guideline engine.
A guideline expression is a boolean test on internal data, with a simple name for a user to use/view/match.
This turns complex DB lookup into a API compatibible expression.
Example: IF “Workflow Step” is “EOS M290” AND “Line Item Field” “Material Type” is “Ti64” THEN suggest to add “Work Instruction Template 56”
In this example: 'Workflow Step' is our Guideline Expression. This is a series of DB look-up/join to find 'line-item['workflow'] => process_step, => 'process_step[workstation]' => workstation['type'] => printer_type['name'].
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau this guideline-expression belongs to. |
comparator | URI |
uri for the specific comparator to be used to evaluate the named_expression |
name | string |
Simple Human Readable display name of the expression |
named_expression | URI |
named-expression uri to be evaluated. |
uri | URI |
The URI of the production guideline expression. |
value | string |
value to compare evaluated named_expression to |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/guideline/for-line-item//
This endpoint is used to find out what Production Guidelines match for this line-item. Submit a line-item UUID as part of the URL, and returns the full list of guidelines that match it (as it exists in the DB). Note this call can be a little slower than some other API endpoints, but still needs to beat our timeout time
ex: IF Workflow Step Name is equal to "EOS M290" ADD Work Instruction "Do a more careful review of the print quality"
This involves taking the provided line-item as the root object and gathering the necessary related resources to determine if the line-item will be using a workflow that has a process-step that will require the print to be made on a printer of type "EOS M290". If this is the case then the work instruction "Do a more careful review of the print quality" will be suggested to the user as a guide.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the work instruction guideline belongs to. |
description | string |
Description of the Guideline |
disabled | boolean |
a guideline that is disabled will not be suggested to a user regardless of evaluation status |
name | string |
Display name for production guideline triggering this suggestion |
process_step_template | URI |
The process step to suggest to the user based on the line-item or related data |
related_workstation_type_name | string |
Name of workstation-type (printer-type, post-processor, shipping) to help linkguidelines/for-work-instruction to specific workflow steps |
source_guideline | URL |
The URI of the production guideline can be of type guideline/for-process-step or guideline/for-line-item |
summary | string |
Human readable representation of guideline. ex: If Line Item Quantity is greater than 10 make this suggestion. |
work_instruction_template | URI |
The work instruction to suggest to the user based on the line-item or related data |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the work instruction guideline belongs to. Required |
description | string |
Description of the Guideline Required |
disabled | boolean |
a guideline that is disabled will not be suggested to a user regardless of evaluation status Required |
name | string |
Display name for production guideline triggering this suggestion Required |
process_step_template | URI |
The process step to suggest to the user based on the line-item or related data Required |
related_workstation_type_name | string |
Name of workstation-type (printer-type, post-processor, shipping) to help linkguidelines/for-work-instruction to specific workflow steps Required |
source_guideline | URL |
The URI of the production guideline can be of type guideline/for-process-step or guideline/for-line-item Required |
summary | string |
Human readable representation of guideline. ex: If Line Item Quantity is greater than 10 make this suggestion. Required |
work_instruction_template | URI |
The work instruction to suggest to the user based on the line-item or related data Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This endpoint is used to find out what Production Guidelines match for this line-item. Submit a line-item UUID as part of the URL, and returns the full list of guidelines that match it (as it exists in the DB). Note this call can be a little slower than some other API endpoints, but still needs to beat our timeout time
ex: IF Workflow Step Name is equal to "EOS M290" ADD Work Instruction "Do a more careful review of the print quality"
This involves taking the provided line-item as the root object and gathering the necessary related resources to determine if the line-item will be using a workflow that has a process-step that will require the print to be made on a printer of type "EOS M290". If this is the case then the work instruction "Do a more careful review of the print quality" will be suggested to the user as a guide.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the work instruction guideline belongs to. |
description | string |
Description of the Guideline |
disabled | boolean |
a guideline that is disabled will not be suggested to a user regardless of evaluation status |
name | string |
Display name for production guideline triggering this suggestion |
process_step_template | URI |
The process step to suggest to the user based on the line-item or related data |
related_workstation_type_name | string |
Name of workstation-type (printer-type, post-processor, shipping) to help linkguidelines/for-work-instruction to specific workflow steps |
source_guideline | URL |
The URI of the production guideline can be of type guideline/for-process-step or guideline/for-line-item |
summary | string |
Human readable representation of guideline. ex: If Line Item Quantity is greater than 10 make this suggestion. |
work_instruction_template | URI |
The work instruction to suggest to the user based on the line-item or related data |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/guideline/for-process-step/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the work instruction guideline belongs to. |
description | string |
Description of the Guideline |
disabled | boolean |
a guideline that is disabled will not be suggested to a user regardless of evaluation status |
guideline_expressions | array |
none available Example: '["..."]'
|
join_operator | string |
how the expressions will be evaluated together. AND/OR Choices
'"and|or"'
|
name | string |
Display name for guideline |
process_step_template | URI |
The process step to suggest to the user |
summary | string |
Human readable representation of guideline. ex: If Line Item Quantity is greater than 10 make this suggestion. |
uri | URI |
The URI of the production guideline. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested guideline cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the work instruction guideline belongs to. Required |
description | string |
Description of the Guideline Required |
disabled | boolean |
a guideline that is disabled will not be suggested to a user regardless of evaluation status Required |
guideline_expressions | array |
none available Required Example: '["..."]'
|
join_operator | string |
how the expressions will be evaluated together. AND/OR Required Choices
'"and|or"'
|
name | string |
Display name for guideline Required |
process_step_template | URI |
The process step to suggest to the user Required |
summary | string |
Human readable representation of guideline. ex: If Line Item Quantity is greater than 10 make this suggestion. Required |
uri | URI |
The URI of the production guideline. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested guideline cannot be found. |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the work instruction guideline belongs to. |
description | string |
Description of the Guideline |
disabled | boolean |
a guideline that is disabled will not be suggested to a user regardless of evaluation status |
guideline_expressions | array |
none available Example: '["..."]'
|
join_operator | string |
how the expressions will be evaluated together. AND/OR Choices
'"and|or"'
|
name | string |
Display name for guideline |
process_step_template | URI |
The process step to suggest to the user |
summary | string |
Human readable representation of guideline. ex: If Line Item Quantity is greater than 10 make this suggestion. |
uri | URI |
The URI of the production guideline. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested guideline cannot be found. |
/guideline/for-work-instruction/
This is the end-goal endpoint of the Production Guideline system. Doing a GET or LIST with filter to this endpoint it used to find a list of template work_instructions the guideline engine recommends to add based on a process-step
Example: IF “Workflow Step” is “EOS M290” AND “Line Item Field” “Material Type” is “Ti64” THEN suggest to add “Work Instruction Template 56”
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the work instruction guideline belongs to. |
description | string |
Description of the Guideline |
disabled | boolean |
a guideline that is disabled will not be suggested to a user regardless of evaluation status |
guideline_expressions | array |
none available Example: '["..."]'
|
join_operator | string |
how the expressions will be evaluated together. AND/OR Choices
'"and|or"'
|
name | string |
Display name for guideline |
related_workstation_uri | URL |
uri of the form /printer-type/, /post-processor-type or /shipping/ |
summary | string |
Human readable representation of guideline. ex: If Line Item Quantity is greater than 10 make this suggestion. |
uri | URI |
The URI of the production guideline. |
work_instruction_template | URI |
The work instruction to suggest to the user |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested guideline cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the work instruction guideline belongs to. Required |
description | string |
Description of the Guideline Required |
disabled | boolean |
a guideline that is disabled will not be suggested to a user regardless of evaluation status Required |
guideline_expressions | array |
none available Required Example: '["..."]'
|
join_operator | string |
how the expressions will be evaluated together. AND/OR Required Choices
'"and|or"'
|
name | string |
Display name for guideline Required |
related_workstation_uri | URL |
uri of the form /printer-type/, /post-processor-type or /shipping/ Required |
summary | string |
Human readable representation of guideline. ex: If Line Item Quantity is greater than 10 make this suggestion. Required |
uri | URI |
The URI of the production guideline. Required |
work_instruction_template | URI |
The work instruction to suggest to the user Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested guideline cannot be found. |
This is the end-goal endpoint of the Production Guideline system. Doing a GET or LIST with filter to this endpoint it used to find a list of template work_instructions the guideline engine recommends to add based on a process-step
Example: IF “Workflow Step” is “EOS M290” AND “Line Item Field” “Material Type” is “Ti64” THEN suggest to add “Work Instruction Template 56”
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the work instruction guideline belongs to. |
description | string |
Description of the Guideline |
disabled | boolean |
a guideline that is disabled will not be suggested to a user regardless of evaluation status |
guideline_expressions | array |
none available Example: '["..."]'
|
join_operator | string |
how the expressions will be evaluated together. AND/OR Choices
'"and|or"'
|
name | string |
Display name for guideline |
related_workstation_uri | URL |
uri of the form /printer-type/, /post-processor-type or /shipping/ |
summary | string |
Human readable representation of guideline. ex: If Line Item Quantity is greater than 10 make this suggestion. |
uri | URI |
The URI of the production guideline. |
work_instruction_template | URI |
The work instruction to suggest to the user |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested guideline cannot be found. |
/guideline/named-expression/
This is a read only endpoint that allows users to list named-expressions. Named-expressions are fields that a user wants to utilize to create guidelines.
Since our users don't have knowledge of our internal schema these names map to a series of evaluation steps that the backend needs to take to calculate the value associated with the named-expression/field. Named expressions are used to create guideline_expressions.
Example: IF “Workflow Step” is “EOS M290” AND “Line Item Field” “Material Type” is “Ti64” THEN suggest to add “Work Instruction Template 56”
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the named_expression belongs to. |
comparators | array |
none available Example: '[{"name": "equals|greater_than|less_than|contains|before|after|on"}]'
|
disabled | boolean |
If disabled the named_expression shouldn't be used for production guideline expressions |
input_type | string |
This field defines the data type of the named_expression. Choices
'"date|string|number"'
|
name | string |
Display name of named-expression |
named_expression_options | array |
none available Example: '[{}]'
|
type | string |
Describes what resource the named expression belongs to Choices
'"order|line-item|process-step"'
|
uri | URI |
The URI of the named-expression. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested named_expression cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the named_expression belongs to. Required |
comparators | array |
none available Default: None Example: '[{"name": "equals|greater_than|less_than|contains|before|after|on"}]'
|
disabled | boolean |
If disabled the named_expression shouldn't be used for production guideline expressions Required |
input_type | string |
This field defines the data type of the named_expression. Default: None Choices
'"date|string|number"'
|
name | string |
Display name of named-expression Default: Unnamed Guideline Name-Expression |
named_expression_options | array |
none available Required Example: '[{}]'
|
type | string |
Describes what resource the named expression belongs to Default: None Choices
'"order|line-item|process-step"'
|
uri | URI |
The URI of the named-expression. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested named_expression cannot be found. |
This is a read only endpoint that allows users to list named-expressions. Named-expressions are fields that a user wants to utilize to create guidelines.
Since our users don't have knowledge of our internal schema these names map to a series of evaluation steps that the backend needs to take to calculate the value associated with the named-expression/field. Named expressions are used to create guideline_expressions.
Example: IF “Workflow Step” is “EOS M290” AND “Line Item Field” “Material Type” is “Ti64” THEN suggest to add “Work Instruction Template 56”
Get a single named_expression by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the named_expression belongs to. |
comparators | array |
none available Example: '[{"name": "equals|greater_than|less_than|contains|before|after|on"}]'
|
disabled | boolean |
If disabled the named_expression shouldn't be used for production guideline expressions |
input_type | string |
This field defines the data type of the named_expression. Choices
'"date|string|number"'
|
name | string |
Display name of named-expression |
named_expression_options | array |
none available Example: '[{}]'
|
type | string |
Describes what resource the named expression belongs to Choices
'"order|line-item|process-step"'
|
uri | URI |
The URI of the named-expression. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested named_expression cannot be found. |
Get the data about all Support Strategy
Schema (application/json)
Property | Type | Description |
---|---|---|
name | string |
The name of the infill strategy. Choices
'"n|a|m|e"'
|
uri | URI |
The URI of the infill strategy. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
RecordNotFound raised |
Get the data about all Support Strategy
Schema (application/json)
Property | Type | Description |
---|---|---|
name | string |
The name of the infill strategy. Choices
'"n|a|m|e"'
|
uri | URI |
The URI of the infill strategy. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
RecordNotFound raised |
/installer/
Get the list of downloads that are available for the different clients we release
Schema (application/json)
Property | Type | Description |
---|---|---|
architecture | string |
The CPU architecture the installer is for Choices
'"x86|amd64"'
|
download | string |
The URL where the installer can be dowloaded. Valid for one hour |
installer | string |
The name of the client this installer is for Choices
'"AuthentiseUpdate|CatalystSlicer|Echo|StreamicsConnector"'
|
platform | string |
The platform, such as Windows or Mac Choices
'"mac|windows"'
|
type | string |
The type of installer, IE what method it uses to install Choices
'"exe|msi"'
|
version | string |
The version of the installer Example: '"1.2.3"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/integration/
This endpoint is a read-only [GET / LIST] Endpoint for finding what integrations the current bureau supports. Note that lighter weight 'features' also exist. An integration is a deeper more computationally intensive connection to a 3rd party service.
handler for HTTPS GET /resource/ , aka 'LIST'.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau URI this is related to . |
context | object |
Read-only. Fields that are bureau (or integration) specific, non-standard data on a specific user.Per bureau use or behavior may change Example: 'null'
|
enabled | boolean |
True if this is active on this bureau |
name | string |
human readable name of this integration Choices
'"castor3d|pathfindr|stripe"'
|
test_date | iso-8601 datetime |
The date that a check/test was last run on this integration. |
test_status | string |
Status of a background/async test running to check the integration. Choices
'"ok|warning|error|queued|running|unknown"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
This endpoint is a read-only [GET / LIST] Endpoint for finding what integrations the current bureau supports. Note that lighter weight 'features' also exist. An integration is a deeper more computationally intensive connection to a 3rd party service.
handler for HTTPS GET /integration/$uuid/
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau URI this is related to . |
context | object |
Read-only. Fields that are bureau (or integration) specific, non-standard data on a specific user.Per bureau use or behavior may change Example: 'null'
|
enabled | boolean |
True if this is active on this bureau |
name | string |
human readable name of this integration Choices
'"castor3d|pathfindr|stripe"'
|
test_date | iso-8601 datetime |
The date that a check/test was last run on this integration. |
test_status | string |
Status of a background/async test running to check the integration. Choices
'"ok|warning|error|queued|running|unknown"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
/job/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
body | string |
none available Required |
method | string |
none available Required Choices
'"GET|PUT|POST"'
|
url | string |
none available Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
/label-relationship/
" Endpoint to apply a label to one item.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. |
label | URI |
The URI of the label. |
target_uri | URL |
Object to apply the label to |
uri | URI |
The URI of the label relationship. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested order cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. Required |
label | URI |
The URI of the label. Required |
target_uri | URL |
Object to apply the label to Required |
uri | URI |
The URI of the label relationship. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested order cannot be found. |
" Endpoint to apply a label to one item.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. |
label | URI |
The URI of the label. |
target_uri | URL |
Object to apply the label to |
uri | URI |
The URI of the label relationship. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested order cannot be found. |
/label/
" This is a general labeling system. This endpoint is for creating the label, or doing a read. Label to assign the endpoint resources is below
List all of the order in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. |
color | string |
HEX Color of the label. Example: (#000000) |
description | string |
2-3 lines of description. |
items | array |
URIs of the related label relationship Example: '["..."]'
|
name | string |
Short name for the tag, 20 characters max. |
uri | URI |
The URI of the label. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested label cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. Required |
color | string |
HEX Color of the label. Example: (#000000) Required |
description | string |
2-3 lines of description. Required |
items | array |
URIs of the related label relationship Default: [] Example: '["..."]'
|
name | string |
Short name for the tag, 20 characters max. Required |
uri | URI |
The URI of the label. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested label cannot be found. |
/label/{uuid}/
" This is a general labeling system. This endpoint is for creating the label, or doing a read. Label to assign the endpoint resources is below
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. |
color | string |
HEX Color of the label. Example: (#000000) |
description | string |
2-3 lines of description. |
items | array |
URIs of the related label relationship Example: '["..."]'
|
name | string |
Short name for the tag, 20 characters max. |
uri | URI |
The URI of the label. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested label cannot be found. |
/labor/
Defines the labor needed to operate a workstation
Schema (application/json)
Property | Type | Description |
---|---|---|
duration | timedelta |
Duration of manual labor needed |
post_processor_type | URI |
The URI of post processor type this schedule applies to. |
printer_type | URI |
The URI of printer type this schedule applies to. |
type | string |
the kind of Labor needed to operate the workstation Choices
'"labor_to_start|labor_to_run"'
|
uri | URI |
The URI of self (this labor record). |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested post_processor_type is already attached to a labor resource. |
403 |
You are not authorized to complete the request. |
404 |
The requested workstation cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
duration | timedelta |
Duration of manual labor needed Required |
post_processor_type | URI |
The URI of post processor type this schedule applies to. Required |
printer_type | URI |
The URI of printer type this schedule applies to. Required |
type | string |
the kind of Labor needed to operate the workstation Required Choices
'"labor_to_start|labor_to_run"'
|
uri | URI |
The URI of self (this labor record). Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested post_processor_type is already attached to a labor resource. |
403 |
You are not authorized to complete the request. |
404 |
The requested workstation cannot be found. |
405 |
|
/labor/{uuid}/
Defines the labor needed to operate a workstation
Schema (application/json)
Property | Type | Description |
---|---|---|
duration | timedelta |
Duration of manual labor needed |
post_processor_type | URI |
The URI of post processor type this schedule applies to. |
printer_type | URI |
The URI of printer type this schedule applies to. |
type | string |
the kind of Labor needed to operate the workstation Choices
'"labor_to_start|labor_to_run"'
|
uri | URI |
The URI of self (this labor record). |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested post_processor_type is already attached to a labor resource. |
403 |
You are not authorized to complete the request. |
404 |
The requested workstation cannot be found. |
405 |
|
/layout/
Layouts are the basic resource for the packing module. In order to create a /layout/
resource a user must provide
a set of model URIs that will be placed in the layout and various paramters about the build volume and the desired
attributes of the layout such as the minimum spacing between models. The system will immediately respond with success
if the paramters are correctly formed. A backend process will then attempt to find a solution to the requested layout
using several parallel approaches. The system will inform the user via the callback URL if provided of any results,
positive or negative. Users can also poll for changes via a GET
request to the created resource
Creates a 2D layout from the set of models provided wherever possible.
Schema (application/json)
Property | Type | Description |
---|---|---|
build | object |
Information about the build volume. The Required Example: ('{"type": "rectangle", "packer_type": '
'"pack2d|pack3d|user_managed|pack3d_premium"}')
|
callback | object |
Callback URL for layout result. A request will be made to this URL using the provided method whenever updates are made to the resource, such as an error or availability of results Default: {} Example: '{}'
|
do_build_volume_check | boolean |
When set, run is checked for ability to fit into the specificed printer_type build volume. Prints that do not fit are left Default: True |
error | string |
The error encountered while processing, if any Default: None Example: '"Failed to create layout"'
|
fill_percentage | float |
The percentage of the build plate that is filled by the models. Values above 100 are an estimate since the algorithm by definition cannot accurately pack more than 100% of the space Default: None Example: '"50.35"'
|
min_packing_distance | float |
Required minimum spacing between the models in the layout in millimeters(mm). Required Example: '"5"'
|
models | array |
The list of model URIs or print URIs that should be placed in this layout Required Example: '["..."]'
|
positions | array |
List of positions of each model in the build plate. Default: None Example: '["..."]'
|
status | string |
Status of the layout. Over the course of creating the resource this will progress from Default: queued Choices
'"queued, processing, complete, error"'
|
uri | URI |
The URI of the layout. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The build parameters are invalid. The model spacing is an invalid value. |
404 |
The requested layout cannot be found. |
/layout/{uuid}/
Layouts are the basic resource for the packing module. In order to create a /layout/
resource a user must provide
a set of model URIs that will be placed in the layout and various paramters about the build volume and the desired
attributes of the layout such as the minimum spacing between models. The system will immediately respond with success
if the paramters are correctly formed. A backend process will then attempt to find a solution to the requested layout
using several parallel approaches. The system will inform the user via the callback URL if provided of any results,
positive or negative. Users can also poll for changes via a GET
request to the created resource
Get a single instance of /layout/
Schema (application/json)
Property | Type | Description |
---|---|---|
build | object |
Information about the build volume. The Example: ('{"type": "rectangle", "packer_type": '
'"pack2d|pack3d|user_managed|pack3d_premium"}')
|
callback | object |
Callback URL for layout result. A request will be made to this URL using the provided method whenever updates are made to the resource, such as an error or availability of results Example: '{}'
|
do_build_volume_check | boolean |
When set, run is checked for ability to fit into the specificed printer_type build volume. Prints that do not fit are left |
error | string |
The error encountered while processing, if any Example: '"Failed to create layout"'
|
fill_percentage | float |
The percentage of the build plate that is filled by the models. Values above 100 are an estimate since the algorithm by definition cannot accurately pack more than 100% of the space Example: '"50.35"'
|
min_packing_distance | float |
Required minimum spacing between the models in the layout in millimeters(mm). Example: '"5"'
|
models | array |
The list of model URIs or print URIs that should be placed in this layout Example: '["..."]'
|
positions | array |
List of positions of each model in the build plate. Example: '["..."]'
|
status | string |
Status of the layout. Over the course of creating the resource this will progress from Choices
'"queued, processing, complete, error"'
|
uri | URI |
The URI of the layout. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The build parameters are invalid. The model spacing is an invalid value. |
404 |
The requested layout cannot be found. |
/library/
Library is the parent for model_library and build_file_library resources. Although they have a relationship they aren't linked in the db:tables via FK but by matching the owner_uris between model_library/build_file_library and the Library. This matching determines the membership to the Library resource. This matching occurs on the front-end. Future: might make this a FK if needed.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau that this library belongs to. |
name | string |
The name of the Library. Read Only |
owner | URL |
The user, bureau, group, custom-group that can see/ edit this Library |
uri | URI |
The library uri(aka itself) |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau that this library belongs to. Required |
name | string |
The name of the Library. Read Only Required |
owner | URL |
The user, bureau, group, custom-group that can see/ edit this Library Required |
uri | URI |
The library uri(aka itself) Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
|
/library/{uuid}/
Library is the parent for model_library and build_file_library resources. Although they have a relationship they aren't linked in the db:tables via FK but by matching the owner_uris between model_library/build_file_library and the Library. This matching determines the membership to the Library resource. This matching occurs on the front-end. Future: might make this a FK if needed.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau that this library belongs to. |
name | string |
The name of the Library. Read Only |
owner | URL |
The user, bureau, group, custom-group that can see/ edit this Library |
uri | URI |
The library uri(aka itself) |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
|
/line-item-actuals/
This contains the log of what has actually happened for a line item.
There is no API to create/edit resource, resources are created automatically when piece actuals is created.
List all line item actuals.
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_costs | array |
A list of manually added additional costs to the line_item. Example: '[{}]'
|
created | iso-8601 datetime |
When line item actuals record was created |
end_in_progress_time | iso-8601 datetime |
When line item was completed (last print of this line item is completed).Can be null if not completed yet or time can't be recognized. |
has_custom_actuals | boolean |
If pieces were give custom workflows different from the line-item, they will not be in this math, and this value will be true. |
line_item | URI |
The URI of the related line item |
per_step_details | array |
List of aggregated actuals per each process steps of this line item. Example: '[{"per_piece_average": {}, "total": {}}]'
|
start_in_progress_time | iso-8601 datetime |
When line item was started (status of first print was changed to in progress). |
total_cost | float |
Sum of material or running cost if this line item. Null if material_cost and running_cost are empty |
updated | iso-8601 datetime |
When line item actuals record was updated last time |
uri | URI |
The URI of the line item actuals record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item actuals cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_costs | array |
A list of manually added additional costs to the line_item. Required Example: '[{}]'
|
created | iso-8601 datetime |
When line item actuals record was created Required |
end_in_progress_time | iso-8601 datetime |
When line item was completed (last print of this line item is completed).Can be null if not completed yet or time can't be recognized. Required |
has_custom_actuals | boolean |
If pieces were give custom workflows different from the line-item, they will not be in this math, and this value will be true. Required |
line_item | URI |
The URI of the related line item Required |
per_step_details | array |
List of aggregated actuals per each process steps of this line item. Required Example: '[{"per_piece_average": {}, "total": {}}]'
|
start_in_progress_time | iso-8601 datetime |
When line item was started (status of first print was changed to in progress). Required |
total_cost | float |
Sum of material or running cost if this line item. Null if material_cost and running_cost are empty Required |
updated | iso-8601 datetime |
When line item actuals record was updated last time Required |
uri | URI |
The URI of the line item actuals record. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item actuals cannot be found. |
405 |
|
This contains the log of what has actually happened for a line item.
There is no API to create/edit resource, resources are created automatically when piece actuals is created.
Get an line item actuals by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_costs | array |
A list of manually added additional costs to the line_item. Example: '[{}]'
|
created | iso-8601 datetime |
When line item actuals record was created |
end_in_progress_time | iso-8601 datetime |
When line item was completed (last print of this line item is completed).Can be null if not completed yet or time can't be recognized. |
has_custom_actuals | boolean |
If pieces were give custom workflows different from the line-item, they will not be in this math, and this value will be true. |
line_item | URI |
The URI of the related line item |
per_step_details | array |
List of aggregated actuals per each process steps of this line item. Example: '[{"per_piece_average": {}, "total": {}}]'
|
start_in_progress_time | iso-8601 datetime |
When line item was started (status of first print was changed to in progress). |
total_cost | float |
Sum of material or running cost if this line item. Null if material_cost and running_cost are empty |
updated | iso-8601 datetime |
When line item actuals record was updated last time |
uri | URI |
The URI of the line item actuals record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item actuals cannot be found. |
405 |
|
Debugging API for listing Line Item Estimates. A Line Item Estimate contains the sum of workstation and labor duration of all the worksteps required to create every piece using the original Workflow for this entire line item"
Schema (application/json)
Property | Type | Description |
---|---|---|
labor_duration | timedelta |
Duration of manual labor needed to complete every piece in the entire line item using the original workflow |
line_item | URI |
The URI of the line item this estimates relates to. |
uri | URI |
The URI of the line-item-estimate record. |
workstation_duration | timedelta |
Duration of workstation needed to complete every piece in the entire line item using the original workflow |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item estimate cannot be found. |
405 |
|
Debugging API for listing Line Item Estimates. A Line Item Estimate contains the sum of workstation and labor duration of all the worksteps required to create every piece using the original Workflow for this entire line item"
Schema (application/json)
Property | Type | Description |
---|---|---|
labor_duration | timedelta |
Duration of manual labor needed to complete every piece in the entire line item using the original workflow |
line_item | URI |
The URI of the line item this estimates relates to. |
uri | URI |
The URI of the line-item-estimate record. |
workstation_duration | timedelta |
Duration of workstation needed to complete every piece in the entire line item using the original workflow |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item estimate cannot be found. |
405 |
|
/line-item-netfabb/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Get a list of all Netfabb line items.
Schema (application/json)
Property | Type | Description |
---|---|---|
action | string |
none available Choices
'"upload|download"'
|
forge_folder_id | string |
none available |
forge_project_id | string |
none available |
last_action | string |
none available Choices
'"upload|download"'
|
last_action_finished_at | iso-8601 datetime |
none available |
last_action_started_at | iso-8601 datetime |
none available |
last_action_status | string |
none available Choices
'"in_progress|complete|error"'
|
line_item | URI |
The URI of the line-item for the netfab export. |
netfabb_project_id | string |
none available |
order | URI |
The URI of order the line-item belongs to. |
uri | URI |
The URI of the Netfabb line item. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested netfab integration cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
action | string |
none available Required Choices
'"upload|download"'
|
forge_folder_id | string |
none available Required |
forge_project_id | string |
none available Required |
last_action | string |
none available Required Choices
'"upload|download"'
|
last_action_finished_at | iso-8601 datetime |
none available Required |
last_action_started_at | iso-8601 datetime |
none available Required |
last_action_status | string |
none available Required Choices
'"in_progress|complete|error"'
|
line_item | URI |
The URI of the line-item for the netfab export. Required |
netfabb_project_id | string |
none available Required |
order | URI |
The URI of order the line-item belongs to. Default: None |
uri | URI |
The URI of the Netfabb line item. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested netfab integration cannot be found. |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Get a Netfabb line item by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
action | string |
none available Choices
'"upload|download"'
|
forge_folder_id | string |
none available |
forge_project_id | string |
none available |
last_action | string |
none available Choices
'"upload|download"'
|
last_action_finished_at | iso-8601 datetime |
none available |
last_action_started_at | iso-8601 datetime |
none available |
last_action_status | string |
none available Choices
'"in_progress|complete|error"'
|
line_item | URI |
The URI of the line-item for the netfab export. |
netfabb_project_id | string |
none available |
order | URI |
The URI of order the line-item belongs to. |
uri | URI |
The URI of the Netfabb line item. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested netfab integration cannot be found. |
If order-quote is enabled, and 'quote-required' set on an Order or Line-Item, then a LineItemQuote is created automatically for the Line Item (or all line-items in the order).
The LineItemQuote is updated / created automatically as line-item data is changed by the backend, especially cost information. (AKA backend creates this, no API POST allowed). This update is tricky on workflow or process_step updates, but otherwise is pretty clear/simple.
If any _price_per is set /overridden by a user via API PUT, the user-set value for that specific workstep is 'sticky' and will always be the value set. IF the workstep is deleted or changed, the specific workstep data may be lost.
Again, A LineItemQuote object is created automatically as the parent Line line-item is updated (workflow changes, etc). This makes it a bit of an expensive endpoint to use.
TEMP DANGER NOTE: line-item['estimate']['total_price'] is affected/latered by this, (OLD ISSUE) as work_step details change, etc
AS OF THIS PR, 'total_price' is here (not in line-item['estimate']['total-price']) if 'quote-required' is set.
if a LineItemQuote exists (if the feature is enabled)Returns info about cost for each line_item's process step
HTTPS GET handler if no uuid provided (list)
Schema (application/json)
Property | Type | Description |
---|---|---|
line_item | URI |
Line Item for which should be calculated estimates. |
public_notes | string |
Public notes to go on the end of the order quote for communicating to customer. |
total_price_per | float |
Price per entire line item instance, in bureau default currency. |
uri | URI |
Link to this exact LineItemQuote, for LIST or other functions |
work_steps_quote_details | array |
List of line item's work_step_quote_details: info about how each line item's workflow process step should influence on the the calculation of line item's Example: ('[{"operation": "printing|post-processing|shipping", "additional_charges": '
'[{}], "updated": "2022-01-01T00:00:00.000000"}]')
|
workflow | URI |
['The workflow this quote was genearted on. Note on a confirmed line-item, or reworked this may not match the current Line Item workflow. ', "Customers are billed on this line-item, it's not the active workflow."] |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
If order-quote is enabled, and 'quote-required' set on an Order or Line-Item, then a LineItemQuote is created automatically for the Line Item (or all line-items in the order).
The LineItemQuote is updated / created automatically as line-item data is changed by the backend, especially cost information. (AKA backend creates this, no API POST allowed). This update is tricky on workflow or process_step updates, but otherwise is pretty clear/simple.
If any _price_per is set /overridden by a user via API PUT, the user-set value for that specific workstep is 'sticky' and will always be the value set. IF the workstep is deleted or changed, the specific workstep data may be lost.
Again, A LineItemQuote object is created automatically as the parent Line line-item is updated (workflow changes, etc). This makes it a bit of an expensive endpoint to use.
TEMP DANGER NOTE: line-item['estimate']['total_price'] is affected/latered by this, (OLD ISSUE) as work_step details change, etc
AS OF THIS PR, 'total_price' is here (not in line-item['estimate']['total-price']) if 'quote-required' is set.
if a LineItemQuote exists (if the feature is enabled)Returns info about cost for each line_item's process step
HTTPS GET handler if uuid provided
Schema (application/json)
Property | Type | Description |
---|---|---|
line_item | URI |
Line Item for which should be calculated estimates. |
public_notes | string |
Public notes to go on the end of the order quote for communicating to customer. |
total_price_per | float |
Price per entire line item instance, in bureau default currency. |
uri | URI |
Link to this exact LineItemQuote, for LIST or other functions |
work_steps_quote_details | array |
List of line item's work_step_quote_details: info about how each line item's workflow process step should influence on the the calculation of line item's Example: ('[{"operation": "printing|post-processing|shipping", "additional_charges": '
'[{}], "updated": "2022-01-01T00:00:00.000000"}]')
|
workflow | URI |
['The workflow this quote was genearted on. Note on a confirmed line-item, or reworked this may not match the current Line Item workflow. ', "Customers are billed on this line-item, it's not the active workflow."] |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
/line-item-report/
The line item report api is for exporting line item information of a given time range.
List all of the line item reports in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. |
content | URL |
the download link for the document |
created | iso-8601 datetime |
The date the report was created. |
end | iso-8601 datetime |
the end datetime within which line items will be reported on. |
start | iso-8601 datetime |
the start datetime within which line items will be reported on. |
status | string |
Status of a report. Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the report. |
user | URI |
The URI of the user making the report. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested report cannot be found. |
Create a new line item report.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. Default: None |
content | URL |
the download link for the document Default: None |
created | iso-8601 datetime |
The date the report was created. Default: None |
end | iso-8601 datetime |
the end datetime within which line items will be reported on. Required |
start | iso-8601 datetime |
the start datetime within which line items will be reported on. Required |
status | string |
Status of a report. Default: None Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the report. Default: None |
user | URI |
The URI of the user making the report. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested report cannot be found. |
The line item report api is for exporting line item information of a given time range.
Get a single line item report by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. |
content | URL |
the download link for the document |
created | iso-8601 datetime |
The date the report was created. |
end | iso-8601 datetime |
the end datetime within which line items will be reported on. |
start | iso-8601 datetime |
the start datetime within which line items will be reported on. |
status | string |
Status of a report. Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the report. |
user | URI |
The URI of the user making the report. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested report cannot be found. |
Return only those line items, that have at least one print without run and with created
status.
This is read-only API designed for ADD RUN page.
List all of the line_item in the system for your account with prints available for a new run.
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Example: '{"materials": {}, "external_analysis": "nebumind"}'
|
available_for_printer | URI |
Filter line-items available for manufacturing in specific printer. |
created | iso-8601 datetime |
The date the line-item was created. |
dimensions | object |
Model dimensions. In API /model/ this field called as 'size' but in this API this word has another meaning. Example: '{}'
|
estimates | object |
Estimates are for the whole line-item (multiple quantity). The print-time estimate is 'simple' assumes running one print after another in a row, on the same machine. Cost is assume in the bureau default currency if not set/flagged. Data is multiplied by quantity on the outgoing exit from the API. Example: '{"estimator": "authentise|shapeways|materialise|prosper|user"}'
|
estimates_additive | object |
none available Example: '{"materials": {}}'
|
estimates_powder | object |
none available Example: 'null'
|
location | URI |
Location of attached order. |
material | URI |
Not nested URI of base material for filtering. |
material_name | string |
Name of material |
name | string |
Human readable line-item name |
order | URI |
The URI of order the line-item belongs to. |
order_due_date | string |
The due date of line-item order |
order_name | string |
The name of line-item's order. |
powder | object |
none available Example: 'null'
|
priority | integer |
The priority score for the line-item, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
quantity | integer |
The number of objects to produce. |
size | float |
This is base size of model in the machine volume: x * y * z. Logic taken from /print/ API for consistency. |
status | string |
Status of an line-item. Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
type | string |
Type of the Line Item Choices
'"product"'
|
updated | iso-8601 datetime |
The date when the line-item was updated |
uri | URI |
The URI of the line-item. |
workflow | URI |
The URI of workflow. |
workflow_type | string |
none available Choices
'"additive_manufacturing|specimen|preparative|powder_manufacturing"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested line-item cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Default: None Example: '{"materials": {}, "external_analysis": "nebumind"}'
|
available_for_printer | URI |
Filter line-items available for manufacturing in specific printer. Required |
created | iso-8601 datetime |
The date the line-item was created. Required |
dimensions | object |
Model dimensions. In API /model/ this field called as 'size' but in this API this word has another meaning. Required Example: '{}'
|
estimates | object |
Estimates are for the whole line-item (multiple quantity). The print-time estimate is 'simple' assumes running one print after another in a row, on the same machine. Cost is assume in the bureau default currency if not set/flagged. Data is multiplied by quantity on the outgoing exit from the API. Required Example: '{"estimator": "authentise|shapeways|materialise|prosper|user"}'
|
estimates_additive | object |
none available Default: None Example: '{"materials": {}}'
|
estimates_powder | object |
none available Default: None Example: 'null'
|
location | URI |
Location of attached order. Required |
material | URI |
Not nested URI of base material for filtering. Required |
material_name | string |
Name of material Required |
name | string |
Human readable line-item name Required |
order | URI |
The URI of order the line-item belongs to. Required |
order_due_date | string |
The due date of line-item order Required |
order_name | string |
The name of line-item's order. Required |
powder | object |
none available Default: None Example: 'null'
|
priority | integer |
The priority score for the line-item, in range 0-100, where 0 is the lowest priority and 100 is the highest priority Default: 65 |
quantity | integer |
The number of objects to produce. Required |
size | float |
This is base size of model in the machine volume: x * y * z. Logic taken from /print/ API for consistency. Required |
status | string |
Status of an line-item. Required Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
type | string |
Type of the Line Item Required Choices
'"product"'
|
updated | iso-8601 datetime |
The date when the line-item was updated Required |
uri | URI |
The URI of the line-item. Required |
workflow | URI |
The URI of workflow. Required |
workflow_type | string |
none available Default: None Choices
'"additive_manufacturing|specimen|preparative|powder_manufacturing"'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested line-item cannot be found. |
Return only those line items, that have at least one print without run and with created
status.
This is read-only API designed for ADD RUN page.
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Example: '{"materials": {}, "external_analysis": "nebumind"}'
|
available_for_printer | URI |
Filter line-items available for manufacturing in specific printer. |
created | iso-8601 datetime |
The date the line-item was created. |
dimensions | object |
Model dimensions. In API /model/ this field called as 'size' but in this API this word has another meaning. Example: '{}'
|
estimates | object |
Estimates are for the whole line-item (multiple quantity). The print-time estimate is 'simple' assumes running one print after another in a row, on the same machine. Cost is assume in the bureau default currency if not set/flagged. Data is multiplied by quantity on the outgoing exit from the API. Example: '{"estimator": "authentise|shapeways|materialise|prosper|user"}'
|
estimates_additive | object |
none available Example: '{"materials": {}}'
|
estimates_powder | object |
none available Example: 'null'
|
location | URI |
Location of attached order. |
material | URI |
Not nested URI of base material for filtering. |
material_name | string |
Name of material |
name | string |
Human readable line-item name |
order | URI |
The URI of order the line-item belongs to. |
order_due_date | string |
The due date of line-item order |
order_name | string |
The name of line-item's order. |
powder | object |
none available Example: 'null'
|
priority | integer |
The priority score for the line-item, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
quantity | integer |
The number of objects to produce. |
size | float |
This is base size of model in the machine volume: x * y * z. Logic taken from /print/ API for consistency. |
status | string |
Status of an line-item. Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
type | string |
Type of the Line Item Choices
'"product"'
|
updated | iso-8601 datetime |
The date when the line-item was updated |
uri | URI |
The URI of the line-item. |
workflow | URI |
The URI of workflow. |
workflow_type | string |
none available Choices
'"additive_manufacturing|specimen|preparative|powder_manufacturing"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested line-item cannot be found. |
/line-item-workstep-cost-estimate/
A Line Item Workstep Cost Estimate contains the values relating to how much it costs to process the line item in one workstep.
Schema (application/json)
Property | Type | Description |
---|---|---|
line_item | URI |
The URI of the line item this estimates relates to. |
number_of_runs | integer |
['The number of times this post process step will run on this line item. Defaults to post-processor-type settings, can be overridden by user on the quote level. if not overridden, we will make an informed decision based on post processor properties such as batching strategy'] |
overhead_cost_per_piece_in_run | float |
The non-recurring cost it takes to process one piece of this line item on this process step. |
overhead_cost_per_run | float |
The non-recurring cost it takes to run this process step. |
process_step | URI |
The URI of the process step this estimate relates to. |
updated | iso-8601 datetime |
updated date of the line item workstep estimate Example: '"2022-01-01T00:00:00.000000"'
|
updated_by | URI |
The user that last updated the estimate. |
uri | URI |
The URI of the line-item-workstep-cost-estimate record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item cost estimate cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
line_item | URI |
The URI of the line item this estimates relates to. Required |
number_of_runs | integer |
['The number of times this post process step will run on this line item. Defaults to post-processor-type settings, can be overridden by user on the quote level. if not overridden, we will make an informed decision based on post processor properties such as batching strategy'] Required |
overhead_cost_per_piece_in_run | float |
The non-recurring cost it takes to process one piece of this line item on this process step. Required |
overhead_cost_per_run | float |
The non-recurring cost it takes to run this process step. Required |
process_step | URI |
The URI of the process step this estimate relates to. Required |
updated | iso-8601 datetime |
updated date of the line item workstep estimate Default: None Example: '"2022-01-01T00:00:00.000000"'
|
updated_by | URI |
The user that last updated the estimate. Required |
uri | URI |
The URI of the line-item-workstep-cost-estimate record. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item cost estimate cannot be found. |
A Line Item Workstep Cost Estimate contains the values relating to how much it costs to process the line item in one workstep.
Schema (application/json)
Property | Type | Description |
---|---|---|
line_item | URI |
The URI of the line item this estimates relates to. |
number_of_runs | integer |
['The number of times this post process step will run on this line item. Defaults to post-processor-type settings, can be overridden by user on the quote level. if not overridden, we will make an informed decision based on post processor properties such as batching strategy'] |
overhead_cost_per_piece_in_run | float |
The non-recurring cost it takes to process one piece of this line item on this process step. |
overhead_cost_per_run | float |
The non-recurring cost it takes to run this process step. |
process_step | URI |
The URI of the process step this estimate relates to. |
updated | iso-8601 datetime |
updated date of the line item workstep estimate Example: '"2022-01-01T00:00:00.000000"'
|
updated_by | URI |
The user that last updated the estimate. |
uri | URI |
The URI of the line-item-workstep-cost-estimate record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item cost estimate cannot be found. |
/line-item-workstep-estimate/
A Line Item Workstep Estimate contains the labor and workstation processing duration of one line item on a workstation.
Schema (application/json)
Property | Type | Description |
---|---|---|
labor_duration | timedelta |
Duration of manual labor needed to complete this process step |
line_item | URI |
The URI of the line item this estimates relates to. |
process_step | URI |
The URI of the process step this estimate relates to. |
updated | iso-8601 datetime |
updated date of the line item workstep estimate Example: '"2022-01-01T00:00:00.000000"'
|
updated_by | URI |
The user that last updated the estimate. |
uri | URI |
The URI of the line-item-estimate record. |
workstation_duration | timedelta |
Duration for a single piece of this line-item to complete this process step |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item estimate cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
labor_duration | timedelta |
Duration of manual labor needed to complete this process step Required |
line_item | URI |
The URI of the line item this estimates relates to. Required |
process_step | URI |
The URI of the process step this estimate relates to. Required |
updated | iso-8601 datetime |
updated date of the line item workstep estimate Default: None Example: '"2022-01-01T00:00:00.000000"'
|
updated_by | URI |
The user that last updated the estimate. Required |
uri | URI |
The URI of the line-item-estimate record. Required |
workstation_duration | timedelta |
Duration for a single piece of this line-item to complete this process step Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item estimate cannot be found. |
A Line Item Workstep Estimate contains the labor and workstation processing duration of one line item on a workstation.
Schema (application/json)
Property | Type | Description |
---|---|---|
labor_duration | timedelta |
Duration of manual labor needed to complete this process step |
line_item | URI |
The URI of the line item this estimates relates to. |
process_step | URI |
The URI of the process step this estimate relates to. |
updated | iso-8601 datetime |
updated date of the line item workstep estimate Example: '"2022-01-01T00:00:00.000000"'
|
updated_by | URI |
The user that last updated the estimate. |
uri | URI |
The URI of the line-item-estimate record. |
workstation_duration | timedelta |
Duration for a single piece of this line-item to complete this process step |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item estimate cannot be found. |
/line-item/
A line-item is a request for a single model to be printed one or more times in a single material. Line-items are used to build up orders and include multiple requests in a single order for things to be built. Line-items are also used to track the status of parts of an order as well as estimate parts of an order.
In general a client will specify the bureau, model, materials, quantity and workflow to be used for the line-item. Other fields are populated by the system as calculations are performed and the order moves through the system towards completion
List all of the line_item in the system for your account. If you don't provide a "type" filter(ex: ?filter[type]=product), a default filter of type "product" will be applied automatically. If you want to list items of any other type you will need to override this default by providing a type filter(see EndUseType in constants.py for possible line-item types). For instance, to find specimen line-items (aka ghost line items) you will need to use the following filter ?filter[type]=specimen.
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_costs | array |
A list of manually added additional costs. Example: '[{}]'
|
additive | object |
none available Example: '{"materials": {}, "external_analysis": "nebumind"}'
|
autorun | boolean |
Enables automatic creation of runs for this line item. |
bureau | URI |
The URI of bureau the line-item belongs to. |
completed_quantity | integer |
The number of objects that finished production(pieces with status: complete). |
created | iso-8601 datetime |
The date the line-item was created. |
custom_field_values | array |
none available Example: '[{}]'
|
customer_id | string |
Human readable alpha-numeric, customer defined ID |
design_time | timedelta |
Time which can take bureau for design review in seconds. Only used if feature order-quote enabled |
error | string |
none available |
estimates | object |
Estimates are for the whole line-item (for the whole quantity). The printing time estimate is 'simple' assumes running one print after another in a row, on the same machine. The post-processing cost assumes the worst scenario when each print run on a different machine. Cost is assume in the bureau default currency if not set/flagged. Example: '{"estimator": "authentise|shapeways|materialise|prosper|user"}'
|
estimates_additive | object |
none available Example: '{"materials": {}}'
|
estimates_powder | object |
none available Example: 'null'
|
is_relevant_estimation | boolean |
flag to skip estimations |
name | string |
Human readable line-item name |
notes | string |
Notes for a line item. |
order | URI |
The URI of order the line-item belongs to. |
powder | object |
none available Example: 'null'
|
prep_workflow | URI |
The URI of prep workflow. |
priority | integer |
The priority score for the line-item, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
product | URI |
The URI of assigned product. Can be null for type != product and for line items without order assigned (they can't be used for runs, see ch29363 for details). Required for POST |
quantity | integer |
The number of objects to attempt production. Not all of them may complete production |
status | string |
Status of an line-item. Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
type | string |
Type of the Line Item. Filter defaults to 'product' on a LIST if type filter not explicitly provided Choices
'"product|specimen|waste|tooling"'
|
uri | URI |
The URI of the line-item. |
workflow | URI |
The URI of workflow to produce these items using. |
workflow_type | string |
none available Choices
'"additive_manufacturing|specimen|preparative|powder_manufacturing"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The quantity value is too low or too high The model does not seem printable Either supply a model uri, or set no_model_upload to True. You cannot do both, and you cannot do neither. An line-item with prints that are associated with a run cannot be deleted Provided status transformation is not allowed Template is required for the line-item. If an order quote are enabled, the parent order's quote must be acceptedbefore child line item status is set to confirmed or equivalent status. Workflow related to the line_item, with type additive_manufacturing, must have an associated printer_type
|
404 |
The requested line-item cannot be found. |
405 |
|
Create a new line_item for HTTP POST.
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_costs | array |
A list of manually added additional costs. Required Example: '[{}]'
|
additive | object |
none available Default: None Example: '{"materials": {}, "external_analysis": "nebumind"}'
|
autorun | boolean |
Enables automatic creation of runs for this line item. Default: False |
bureau | URI |
The URI of bureau the line-item belongs to. Required |
completed_quantity | integer |
The number of objects that finished production(pieces with status: complete). Required |
created | iso-8601 datetime |
The date the line-item was created. Default: None |
custom_field_values | array |
none available Default: None Example: '[{}]'
|
customer_id | string |
Human readable alpha-numeric, customer defined ID Default: None |
design_time | timedelta |
Time which can take bureau for design review in seconds. Only used if feature order-quote enabled Default: None |
error | string |
none available Default: None |
estimates | object |
Estimates are for the whole line-item (for the whole quantity). The printing time estimate is 'simple' assumes running one print after another in a row, on the same machine. The post-processing cost assumes the worst scenario when each print run on a different machine. Cost is assume in the bureau default currency if not set/flagged. Default: None Example: '{"estimator": "authentise|shapeways|materialise|prosper|user"}'
|
estimates_additive | object |
none available Default: None Example: '{"materials": {}}'
|
estimates_powder | object |
none available Default: None Example: 'null'
|
is_relevant_estimation | boolean |
flag to skip estimations Default: True |
name | string |
Human readable line-item name Default: None |
notes | string |
Notes for a line item. Default: None |
order | URI |
The URI of order the line-item belongs to. Required |
powder | object |
none available Default: None Example: 'null'
|
prep_workflow | URI |
The URI of prep workflow. Default: None |
priority | integer |
The priority score for the line-item, in range 0-100, where 0 is the lowest priority and 100 is the highest priority Default: 65 |
product | URI |
The URI of assigned product. Can be null for type != product and for line items without order assigned (they can't be used for runs, see ch29363 for details). Required for POST Required |
quantity | integer |
The number of objects to attempt production. Not all of them may complete production Required |
status | string |
Status of an line-item. Default: None Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
type | string |
Type of the Line Item. Filter defaults to 'product' on a LIST if type filter not explicitly provided Default: None Choices
'"product|specimen|waste|tooling"'
|
uri | URI |
The URI of the line-item. Default: None |
workflow | URI |
The URI of workflow to produce these items using. Default: None |
workflow_type | string |
none available Default: None Choices
'"additive_manufacturing|specimen|preparative|powder_manufacturing"'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The quantity value is too low or too high The model does not seem printable Either supply a model uri, or set no_model_upload to True. You cannot do both, and you cannot do neither. An line-item with prints that are associated with a run cannot be deleted Provided status transformation is not allowed Template is required for the line-item. If an order quote are enabled, the parent order's quote must be acceptedbefore child line item status is set to confirmed or equivalent status. Workflow related to the line_item, with type additive_manufacturing, must have an associated printer_type
|
404 |
The requested line-item cannot be found. |
405 |
|
/line-item//clone/
Based on line_item_uuid
(target line item) received in URL, copy line-item and attach it to the target line-item's order.
Additionally, copy next resources (if they exists)::
- all required permissions;
- related documents (additional line item's documents);
- latest quote (db:quote);
- `line_item_quote` with related `line_item_work_step_quote_details`;
- custom line_item-level workflow (if target line item has custom workflow).
TODO:
Important note: temporary cloning related product + line_item while API for /product/
Schema (application/json)
Property | Type | Description |
---|---|---|
quantity | integer |
The number of pieces to produce in this clone. If not found, the original line-item's quantity will be used instead. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested line item cannot be found. |
This is an internal API that is used by the estimation and slicing system to report back the status of the estimation process
Schema (application/json)
Property | Type | Description |
---|---|---|
error | string |
none available Default: None |
slice_time_ms | integer |
none available Default: 0 |
slicing_uri | URL |
none available Required |
status | string |
none available Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested line item cannot be found. |
A line-item is a request for a single model to be printed one or more times in a single material. Line-items are used to build up orders and include multiple requests in a single order for things to be built. Line-items are also used to track the status of parts of an order as well as estimate parts of an order.
In general a client will specify the bureau, model, materials, quantity and workflow to be used for the line-item. Other fields are populated by the system as calculations are performed and the order moves through the system towards completion
Get a single line_item by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_costs | array |
A list of manually added additional costs. Example: '[{}]'
|
additive | object |
none available Example: '{"materials": {}, "external_analysis": "nebumind"}'
|
autorun | boolean |
Enables automatic creation of runs for this line item. |
bureau | URI |
The URI of bureau the line-item belongs to. |
completed_quantity | integer |
The number of objects that finished production(pieces with status: complete). |
created | iso-8601 datetime |
The date the line-item was created. |
custom_field_values | array |
none available Example: '[{}]'
|
customer_id | string |
Human readable alpha-numeric, customer defined ID |
design_time | timedelta |
Time which can take bureau for design review in seconds. Only used if feature order-quote enabled |
error | string |
none available |
estimates | object |
Estimates are for the whole line-item (for the whole quantity). The printing time estimate is 'simple' assumes running one print after another in a row, on the same machine. The post-processing cost assumes the worst scenario when each print run on a different machine. Cost is assume in the bureau default currency if not set/flagged. Example: '{"estimator": "authentise|shapeways|materialise|prosper|user"}'
|
estimates_additive | object |
none available Example: '{"materials": {}}'
|
estimates_powder | object |
none available Example: 'null'
|
is_relevant_estimation | boolean |
flag to skip estimations |
name | string |
Human readable line-item name |
notes | string |
Notes for a line item. |
order | URI |
The URI of order the line-item belongs to. |
powder | object |
none available Example: 'null'
|
prep_workflow | URI |
The URI of prep workflow. |
priority | integer |
The priority score for the line-item, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
product | URI |
The URI of assigned product. Can be null for type != product and for line items without order assigned (they can't be used for runs, see ch29363 for details). Required for POST |
quantity | integer |
The number of objects to attempt production. Not all of them may complete production |
status | string |
Status of an line-item. Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
type | string |
Type of the Line Item. Filter defaults to 'product' on a LIST if type filter not explicitly provided Choices
'"product|specimen|waste|tooling"'
|
uri | URI |
The URI of the line-item. |
workflow | URI |
The URI of workflow to produce these items using. |
workflow_type | string |
none available Choices
'"additive_manufacturing|specimen|preparative|powder_manufacturing"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The quantity value is too low or too high The model does not seem printable Either supply a model uri, or set no_model_upload to True. You cannot do both, and you cannot do neither. An line-item with prints that are associated with a run cannot be deleted Provided status transformation is not allowed Template is required for the line-item. If an order quote are enabled, the parent order's quote must be acceptedbefore child line item status is set to confirmed or equivalent status. Workflow related to the line_item, with type additive_manufacturing, must have an associated printer_type
|
404 |
The requested line-item cannot be found. |
405 |
|
/location-settings/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
location | URI |
The URI of the location the settings belongs to. |
notification_line_items_confirmed | boolean |
Indicates whether location contacts at this location should receive email notification when all line items in an order at this location are confirmed. |
notification_order_completed | boolean |
Indicates whether location contacts at this location should receive email notification when an order at this location has been completed. |
notification_order_created | boolean |
Indicates whether location contacts at this location should receive email notification when an order is created and assigned to this location. |
notification_order_owner | boolean |
Indicates whether location contacts at this location should receive email notification when an order is created with owner and assigned to this location. |
notification_order_scheduled | boolean |
Indicates whether location contacts at this location should receive email notification when all objects in an order at this location have been scheduled. |
notification_order_started_printing | boolean |
Indicates whether location contacts at this location should receive email notification when the first line item in an order at this location starts printing. |
notification_print_error | boolean |
Indicates whether location contacts at this location should receive email notification when printing fails for any object in an order at this location. |
uri | URI |
The URI of the location-settings resource. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
|
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
location | URI |
The URI of the location the settings belongs to. Required |
notification_line_items_confirmed | boolean |
Indicates whether location contacts at this location should receive email notification when all line items in an order at this location are confirmed. Default: False |
notification_order_completed | boolean |
Indicates whether location contacts at this location should receive email notification when an order at this location has been completed. Default: False |
notification_order_created | boolean |
Indicates whether location contacts at this location should receive email notification when an order is created and assigned to this location. Default: False |
notification_order_owner | boolean |
Indicates whether location contacts at this location should receive email notification when an order is created with owner and assigned to this location. Default: False |
notification_order_scheduled | boolean |
Indicates whether location contacts at this location should receive email notification when all objects in an order at this location have been scheduled. Default: False |
notification_order_started_printing | boolean |
Indicates whether location contacts at this location should receive email notification when the first line item in an order at this location starts printing. Default: False |
notification_print_error | boolean |
Indicates whether location contacts at this location should receive email notification when printing fails for any object in an order at this location. Default: False |
uri | URI |
The URI of the location-settings resource. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
|
405 |
|
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
location | URI |
The URI of the location the settings belongs to. |
notification_line_items_confirmed | boolean |
Indicates whether location contacts at this location should receive email notification when all line items in an order at this location are confirmed. |
notification_order_completed | boolean |
Indicates whether location contacts at this location should receive email notification when an order at this location has been completed. |
notification_order_created | boolean |
Indicates whether location contacts at this location should receive email notification when an order is created and assigned to this location. |
notification_order_owner | boolean |
Indicates whether location contacts at this location should receive email notification when an order is created with owner and assigned to this location. |
notification_order_scheduled | boolean |
Indicates whether location contacts at this location should receive email notification when all objects in an order at this location have been scheduled. |
notification_order_started_printing | boolean |
Indicates whether location contacts at this location should receive email notification when the first line item in an order at this location starts printing. |
notification_print_error | boolean |
Indicates whether location contacts at this location should receive email notification when printing fails for any object in an order at this location. |
uri | URI |
The URI of the location-settings resource. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
|
405 |
|
/location/
Locations are normally set up shortly after a bureau. This is because several other resources need to have a location
defined
in order to create them such as printers. The location identifies an office where a bureau might maintain stock or process
orders from customers or ship out finished goods.
List all of the locations in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
address | string |
The address of the location. |
bureau | URI |
The URI of the bureau. |
contact | URI |
The URI of the user that will be the contact of the location. |
countries_served | array |
list of country codes served by this manufacturing location Example: '["..."]'
|
group | URI |
The URI of the user group. |
name | string |
The name of the location. |
order_completion_note | string |
Text to append to order completion email when an order assigned to this location is completed. |
phone | string |
The phone of the location. |
uri | URI |
The URI of the location. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
You cannot change a location's group. The requested location name already exists. The requested location name already exists. Could not delete location's group.
|
403 |
You are not authorized to complete the request. |
404 |
The requested location cannot be found. |
Create a new location.
Schema (application/json)
Property | Type | Description |
---|---|---|
address | string |
The address of the location. Required |
bureau | URI |
The URI of the bureau. Required |
contact | URI |
The URI of the user that will be the contact of the location. Default: None |
countries_served | array |
list of country codes served by this manufacturing location Default: None Example: '["..."]'
|
group | URI |
The URI of the user group. Default: None |
name | string |
The name of the location. Required |
order_completion_note | string |
Text to append to order completion email when an order assigned to this location is completed. Default:
|
phone | string |
The phone of the location. Default: None |
uri | URI |
The URI of the location. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
You cannot change a location's group. The requested location name already exists. The requested location name already exists. Could not delete location's group.
|
403 |
You are not authorized to complete the request. |
404 |
The requested location cannot be found. |
Locations are normally set up shortly after a bureau. This is because several other resources need to have a location
defined
in order to create them such as printers. The location identifies an office where a bureau might maintain stock or process
orders from customers or ship out finished goods.
Get a single location by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
address | string |
The address of the location. |
bureau | URI |
The URI of the bureau. |
contact | URI |
The URI of the user that will be the contact of the location. |
countries_served | array |
list of country codes served by this manufacturing location Example: '["..."]'
|
group | URI |
The URI of the user group. |
name | string |
The name of the location. |
order_completion_note | string |
Text to append to order completion email when an order assigned to this location is completed. |
phone | string |
The phone of the location. |
uri | URI |
The URI of the location. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
You cannot change a location's group. The requested location name already exists. The requested location name already exists. Could not delete location's group.
|
403 |
You are not authorized to complete the request. |
404 |
The requested location cannot be found. |
/manufacturer/
A manufacturer represents an organization that creates a printer. This allows the system to keep track of what organization makes the printer to group printers with similar capabilities, support contracts and sales contacts together for convenience
Without filters - list all of the manufacturers in the system for user's bureau.
By default - will return all records for Bureau and exclude all templates.
If passed is_template == True
- will will return only shared between bureaus records
and will exclude manufacturers for current user bureau.
Schema (application/json)
Property | Type | Description |
---|---|---|
address | string |
The address of the manufacturer. |
base_template | URI |
Indicates the URI of Manufacture (from the shared library with |
contact | object |
The user that will be the contact of the manufacturer. Example: '{}'
|
custom_field_values | array |
none available Example: '[{}]'
|
is_template | boolean |
Indicates, that this |
name | string |
The name of the manufacturer. |
notes | string |
Notes about manufacturer. |
support | object |
The user that will be the support contact of the manufacturer. Example: '{}'
|
uri | URI |
The URI of the manufacturer. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested manufacturer name already exists. |
403 |
Modification of template manufacturer not allowed via API. You are not authorized to complete the request. |
404 |
The requested manufacturer cannot be found. |
Create a new manufacturer.
Schema (application/json)
Property | Type | Description |
---|---|---|
address | string |
The address of the manufacturer. Required |
base_template | URI |
Indicates the URI of Manufacture (from the shared library with Required |
contact | object |
The user that will be the contact of the manufacturer. Required Example: '{}'
|
custom_field_values | array |
none available Default: None Example: '[{}]'
|
is_template | boolean |
Indicates, that this Required |
name | string |
The name of the manufacturer. Required |
notes | string |
Notes about manufacturer. Required |
support | object |
The user that will be the support contact of the manufacturer. Required Example: '{}'
|
uri | URI |
The URI of the manufacturer. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested manufacturer name already exists. |
403 |
Modification of template manufacturer not allowed via API. You are not authorized to complete the request. |
404 |
The requested manufacturer cannot be found. |
A manufacturer represents an organization that creates a printer. This allows the system to keep track of what organization makes the printer to group printers with similar capabilities, support contracts and sales contacts together for convenience
Get a single manufacturer by UUID. Template (shared) manufacturers not available here - only bureau level.
Schema (application/json)
Property | Type | Description |
---|---|---|
address | string |
The address of the manufacturer. |
base_template | URI |
Indicates the URI of Manufacture (from the shared library with |
contact | object |
The user that will be the contact of the manufacturer. Example: '{}'
|
custom_field_values | array |
none available Example: '[{}]'
|
is_template | boolean |
Indicates, that this |
name | string |
The name of the manufacturer. |
notes | string |
Notes about manufacturer. |
support | object |
The user that will be the support contact of the manufacturer. Example: '{}'
|
uri | URI |
The URI of the manufacturer. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested manufacturer name already exists. |
403 |
Modification of template manufacturer not allowed via API. You are not authorized to complete the request. |
404 |
The requested manufacturer cannot be found. |
/material-batch-action/
This endpoint is called to log an action on a batch into the system. Things like loading a machine, sifting material out of a batch, or unloading a machine are logged here. This triggers actions on batches, and create log of what actions (log also appears in the traceability report).
This is a POST/GET/LIST only interface. PUT and DELETE is not allowed.
Most of actions will updated a source_batch
; some of actions will create a new batch as output, if so,
that batch will be returned in the header as a header["location"] value.
Schema (application/json)
Property | Type | Description |
---|---|---|
action_type | string |
The action type we want to take on the specified batch Choices
'"blend_batches|create_initial_batch|machine_unload_chamber|machine_unload_hopper|split_batch|add_container|containerize_batch|edit_batch_quantity|machine_load|machine_top_off|scrap_batch|sieve|test|relocate"'
|
created | iso-8601 datetime |
The date the batch_action was created. |
metadata | object |
Action specific JSON blob for action metadata. See METADATA_SIGNATURES for more details. Example: 'null'
|
notes | string |
Custom user description/notes for this action. |
previous_action | URI |
The URI of the previous Material Batch Action to the 'source_batch' (if exists). |
quantity | float |
Amountof material from 'source_batch' (or destination batch - for blend action) used in action: - machine_load - the quantity loaded to a machine; - split_batch - the quantity which was moved into the new batch; - blend_batches - the quantity in the resulting (blended) batch; - test - quantity of material consumed in the test; - edit_batch_quantity - resulting quantity in the batch; - machine_unload_chamber, machine_unload_hopper - the quantity unloaded from the machine; - scrap_batch, sieve_batch, containerize_batch - full quantity in the batch; - create_initial_batch - base quantity in the initial batch (calculated based on containers); - machine_top_off - quantity added to the printer from the 'batch_to_load'. |
source_batch | URI |
URI of the material batch to which the action applies. Null allowed only for POST on initial batch creation. |
uri | URI |
Material Batch Action's URI. |
user | URI |
A user whom performed an action |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
|
In order to transferring quantity (it is in "units" when sending to the backend) to core_unit, we need to get the "units" of the material. The logic to get it through db call is that:
- If there's source batch, get the source batch, and use the "units" in the source batch -- this logic is implemented in _dehydrate function
- If there's no source batch, it must be create_initial_batch. We get the container from the metadata and then use the container to get units.
If we want to improve this in the future, I hope we can get the units field from the Frontend, which is the easiest method.
Schema (application/json)
Property | Type | Description |
---|---|---|
action_type | string |
The action type we want to take on the specified batch Required Choices
'"blend_batches|create_initial_batch|machine_unload_chamber|machine_unload_hopper|split_batch|add_container|containerize_batch|edit_batch_quantity|machine_load|machine_top_off|scrap_batch|sieve|test|relocate"'
|
created | iso-8601 datetime |
The date the batch_action was created. Required |
metadata | object |
Action specific JSON blob for action metadata. See METADATA_SIGNATURES for more details. Default: {} Example: 'null'
|
notes | string |
Custom user description/notes for this action. Required |
previous_action | URI |
The URI of the previous Material Batch Action to the 'source_batch' (if exists). Required |
quantity | float |
Amountof material from 'source_batch' (or destination batch - for blend action) used in action: - machine_load - the quantity loaded to a machine; - split_batch - the quantity which was moved into the new batch; - blend_batches - the quantity in the resulting (blended) batch; - test - quantity of material consumed in the test; - edit_batch_quantity - resulting quantity in the batch; - machine_unload_chamber, machine_unload_hopper - the quantity unloaded from the machine; - scrap_batch, sieve_batch, containerize_batch - full quantity in the batch; - create_initial_batch - base quantity in the initial batch (calculated based on containers); - machine_top_off - quantity added to the printer from the 'batch_to_load'. Default: 0 |
source_batch | URI |
URI of the material batch to which the action applies. Null allowed only for POST on initial batch creation. Required |
uri | URI |
Material Batch Action's URI. Required |
user | URI |
A user whom performed an action Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
|
This endpoint is called to log an action on a batch into the system. Things like loading a machine, sifting material out of a batch, or unloading a machine are logged here. This triggers actions on batches, and create log of what actions (log also appears in the traceability report).
This is a POST/GET/LIST only interface. PUT and DELETE is not allowed.
Most of actions will updated a source_batch
; some of actions will create a new batch as output, if so,
that batch will be returned in the header as a header["location"] value.
Schema (application/json)
Property | Type | Description |
---|---|---|
action_type | string |
The action type we want to take on the specified batch Choices
'"blend_batches|create_initial_batch|machine_unload_chamber|machine_unload_hopper|split_batch|add_container|containerize_batch|edit_batch_quantity|machine_load|machine_top_off|scrap_batch|sieve|test|relocate"'
|
created | iso-8601 datetime |
The date the batch_action was created. |
metadata | object |
Action specific JSON blob for action metadata. See METADATA_SIGNATURES for more details. Example: 'null'
|
notes | string |
Custom user description/notes for this action. |
previous_action | URI |
The URI of the previous Material Batch Action to the 'source_batch' (if exists). |
quantity | float |
Amountof material from 'source_batch' (or destination batch - for blend action) used in action: - machine_load - the quantity loaded to a machine; - split_batch - the quantity which was moved into the new batch; - blend_batches - the quantity in the resulting (blended) batch; - test - quantity of material consumed in the test; - edit_batch_quantity - resulting quantity in the batch; - machine_unload_chamber, machine_unload_hopper - the quantity unloaded from the machine; - scrap_batch, sieve_batch, containerize_batch - full quantity in the batch; - create_initial_batch - base quantity in the initial batch (calculated based on containers); - machine_top_off - quantity added to the printer from the 'batch_to_load'. |
source_batch | URI |
URI of the material batch to which the action applies. Null allowed only for POST on initial batch creation. |
uri | URI |
Material Batch Action's URI. |
user | URI |
A user whom performed an action |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
|
Representing relationships (linkings) between Material Batches (the graph faces).
Material Batch Linking can be only created as side-effect of Material Batch Action (update and deleted not allowed at all).
Schema (application/json)
Property | Type | Description |
---|---|---|
action | URI |
The URI of the Material Batch Action which created the Material Batch Linking. |
containers | array |
URIs of material containers which were transferred from the source_batch to the destination_batch. Example: '["..."]'
|
destination_batch | URI |
URI of the destination material batch which created as an action result. |
quantity | float |
Initial quantity in the destination_batch. |
source_batch | URI |
URI of the source material batch to which the action applied. |
uri | URI |
Material Batch Linking's URI. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
|
Representing relationships (linkings) between Material Batches (the graph faces).
Material Batch Linking can be only created as side-effect of Material Batch Action (update and deleted not allowed at all).
Schema (application/json)
Property | Type | Description |
---|---|---|
action | URI |
The URI of the Material Batch Action which created the Material Batch Linking. |
containers | array |
URIs of material containers which were transferred from the source_batch to the destination_batch. Example: '["..."]'
|
destination_batch | URI |
URI of the destination material batch which created as an action result. |
quantity | float |
Initial quantity in the destination_batch. |
source_batch | URI |
URI of the source material batch to which the action applied. |
uri | URI |
Material Batch Linking's URI. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
|
/material-batch-traceability-report/
The traceability report api is for exporting the events that transpired during the creation of a given object as a printable document.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. |
content | URL |
the download link for the document |
created | iso-8601 datetime |
The date the report was created. |
material_batch | URI |
The Material Batch to get a report on. |
status | string |
Status of a report processing stage. Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the report. |
user | URI |
The URI of the user making the report. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested material batch report cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. Default: None |
content | URL |
the download link for the document Required |
created | iso-8601 datetime |
The date the report was created. Required |
material_batch | URI |
The Material Batch to get a report on. Required |
status | string |
Status of a report processing stage. Required Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the report. Default: None |
user | URI |
The URI of the user making the report. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested material batch report cannot be found. |
The traceability report api is for exporting the events that transpired during the creation of a given object as a printable document.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. |
content | URL |
the download link for the document |
created | iso-8601 datetime |
The date the report was created. |
material_batch | URI |
The Material Batch to get a report on. |
status | string |
Status of a report processing stage. Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the report. |
user | URI |
The URI of the user making the report. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested material batch report cannot be found. |
/material-batch/
This endpoints Stores data on a batch. A batch is a mass of material that we want to track the use/history on.
Some batches are ‘in containers’ (they are still moved/stored in containers), and other have been removed from individual containers, and are all mixed together (we will call this a ‘bin’ ) .
Even after moving to ‘bin’ we need to track source containers, use count, etc.
Schema (application/json)
Property | Type | Description |
---|---|---|
at_machine | URI |
The machine this is loaded into/at, or null if not at a machine |
containers | array |
List of active (containers currently associated with/used by this batch) containers URIs. Example: '["..."]'
|
created | iso-8601 datetime |
The date the material batch was created. |
custom_status | string |
Authentise Admin created states. Varies per bureau |
full_quantity | float |
The maximum amount of material in this batch, ever |
initial_batch | URI |
URI of initial batch (batch created directly from the Material Lot). |
is_initial_batch | boolean |
Is it the same batch as material_batch.initial_batch. |
location | URI |
The URI of the lot’s location |
location_name | string |
Location name |
material_in_containers | boolean |
True if this batch is still stored in containers, False if they are now mixed together in a bin |
material_lots | array |
List of all source material_lot's URI. Max 10. Example: '["..."]'
|
materials | array |
Helper data about parent lots, to reduce calls to material - lot.Max 10 Example: ('[{"units": "cm3|mm3|inch3|gram|kg|lb", "cost": "100.00", "type": '
'"support|base"}]')
|
notes | string |
Notes for the material batch. |
quantity | float |
Current quantity in the batch: reserved_quantity (loaded into machine or in test) + quantity_available_for_actions (material which can be used for split, scrap_batch, and other actions)Quantity is in units |
quantity_available_for_actions | float |
Quantity which can be used for split, scrap_batch, and other actions. |
reserved_quantity | float |
Quantity which was loaded into printer, or used in tests or any quantity reserved by actions, which can be returned back to the batch only by another action |
source_material_batches | array |
none available Example: '["..."]'
|
status | string |
Status of material batch Choices
'"new|in_use|done"'
|
sub_location | URI |
The URI of the batch’s sub_location |
units | string |
Unit of material Choices
'"cm3|mm3|inch3|gram|kg|lb"'
|
updated | iso-8601 datetime |
The date the material batch was updated. |
uri | URI |
URI to our own material batch |
usage_cycles | integer |
Total use-count of oldest portion of material in this mix |
uuid | uuid |
The UUID of the material batch. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. Modification of material batch not allowed via API. |
404 |
The requested material batch cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
at_machine | URI |
The machine this is loaded into/at, or null if not at a machine Default: None |
containers | array |
List of active (containers currently associated with/used by this batch) containers URIs. Required Example: '["..."]'
|
created | iso-8601 datetime |
The date the material batch was created. Required |
custom_status | string |
Authentise Admin created states. Varies per bureau Default: None |
full_quantity | float |
The maximum amount of material in this batch, ever Required |
initial_batch | URI |
URI of initial batch (batch created directly from the Material Lot). Required |
is_initial_batch | boolean |
Is it the same batch as material_batch.initial_batch. Required |
location | URI |
The URI of the lot’s location Required |
location_name | string |
Location name Required |
material_in_containers | boolean |
True if this batch is still stored in containers, False if they are now mixed together in a bin Default: True |
material_lots | array |
List of all source material_lot's URI. Max 10. Required Example: '["..."]'
|
materials | array |
Helper data about parent lots, to reduce calls to material - lot.Max 10 Required Example: ('[{"units": "cm3|mm3|inch3|gram|kg|lb", "cost": "100.00", "type": '
'"support|base"}]')
|
notes | string |
Notes for the material batch. Default: None |
quantity | float |
Current quantity in the batch: reserved_quantity (loaded into machine or in test) + quantity_available_for_actions (material which can be used for split, scrap_batch, and other actions)Quantity is in units Required |
quantity_available_for_actions | float |
Quantity which can be used for split, scrap_batch, and other actions. Required |
reserved_quantity | float |
Quantity which was loaded into printer, or used in tests or any quantity reserved by actions, which can be returned back to the batch only by another action Required |
source_material_batches | array |
none available Default: None Example: '["..."]'
|
status | string |
Status of material batch Default: None Choices
'"new|in_use|done"'
|
sub_location | URI |
The URI of the batch’s sub_location Required |
units | string |
Unit of material Default: None Choices
'"cm3|mm3|inch3|gram|kg|lb"'
|
updated | iso-8601 datetime |
The date the material batch was updated. Required |
uri | URI |
URI to our own material batch Default: None |
usage_cycles | integer |
Total use-count of oldest portion of material in this mix Default: None |
uuid | uuid |
The UUID of the material batch. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. Modification of material batch not allowed via API. |
404 |
The requested material batch cannot be found. |
This endpoints Stores data on a batch. A batch is a mass of material that we want to track the use/history on.
Some batches are ‘in containers’ (they are still moved/stored in containers), and other have been removed from individual containers, and are all mixed together (we will call this a ‘bin’ ) .
Even after moving to ‘bin’ we need to track source containers, use count, etc.
Schema (application/json)
Property | Type | Description |
---|---|---|
at_machine | URI |
The machine this is loaded into/at, or null if not at a machine |
containers | array |
List of active (containers currently associated with/used by this batch) containers URIs. Example: '["..."]'
|
created | iso-8601 datetime |
The date the material batch was created. |
custom_status | string |
Authentise Admin created states. Varies per bureau |
full_quantity | float |
The maximum amount of material in this batch, ever |
initial_batch | URI |
URI of initial batch (batch created directly from the Material Lot). |
is_initial_batch | boolean |
Is it the same batch as material_batch.initial_batch. |
location | URI |
The URI of the lot’s location |
location_name | string |
Location name |
material_in_containers | boolean |
True if this batch is still stored in containers, False if they are now mixed together in a bin |
material_lots | array |
List of all source material_lot's URI. Max 10. Example: '["..."]'
|
materials | array |
Helper data about parent lots, to reduce calls to material - lot.Max 10 Example: ('[{"units": "cm3|mm3|inch3|gram|kg|lb", "cost": "100.00", "type": '
'"support|base"}]')
|
notes | string |
Notes for the material batch. |
quantity | float |
Current quantity in the batch: reserved_quantity (loaded into machine or in test) + quantity_available_for_actions (material which can be used for split, scrap_batch, and other actions)Quantity is in units |
quantity_available_for_actions | float |
Quantity which can be used for split, scrap_batch, and other actions. |
reserved_quantity | float |
Quantity which was loaded into printer, or used in tests or any quantity reserved by actions, which can be returned back to the batch only by another action |
source_material_batches | array |
none available Example: '["..."]'
|
status | string |
Status of material batch Choices
'"new|in_use|done"'
|
sub_location | URI |
The URI of the batch’s sub_location |
units | string |
Unit of material Choices
'"cm3|mm3|inch3|gram|kg|lb"'
|
updated | iso-8601 datetime |
The date the material batch was updated. |
uri | URI |
URI to our own material batch |
usage_cycles | integer |
Total use-count of oldest portion of material in this mix |
uuid | uuid |
The UUID of the material batch. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. Modification of material batch not allowed via API. |
404 |
The requested material batch cannot be found. |
/material-container/
This endpoint represents containers and it's usage in batches.
A container is part of a Material Lot
(as a root object, tracking starting state) and also a part of a material batch.
Container to Lot
relationships never change (maybe in the future this feature can be provided).
Container to Batch
relationship changes very often (via /material-batch-action/ API).
In many places, a material_container gets scanned, and the current material_batch that container is related to is brought up in the QR app to make changes to.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date the material container was created. |
current_batch | URI |
The URI of the batch which currently using this container. When there are no batches, created from the material lot, it can be equals to None. |
full_quantity | float |
The maximum (initial) amount of the material in this container |
is_available_for_initial_batches | boolean |
Is material containers can be used to create a new initial batch or not. |
location | URI |
The URI of the containers's location. |
material | URI |
The URI of the material in the container (we take it from the material lot). |
material_lot | URI |
The URI of the material lot in which this container was created. If NULL - it is internal bureau container created via action 'batch_containerize'. |
quantity | float |
The current amount of the material in this container |
status | string |
Current status of the material container Choices
'"new|in_use|empty"'
|
sub_location | URI |
The URI of the containers’s sub_location |
uri | URI |
URI of the material container |
used_in_batches | array |
A list of material batches where container used before (in most cases there will be one value). Example: '["..."]'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested material_container cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date the material container was created. Required |
current_batch | URI |
The URI of the batch which currently using this container. When there are no batches, created from the material lot, it can be equals to None. Required |
full_quantity | float |
The maximum (initial) amount of the material in this container Required |
is_available_for_initial_batches | boolean |
Is material containers can be used to create a new initial batch or not. Required |
location | URI |
The URI of the containers's location. Required |
material | URI |
The URI of the material in the container (we take it from the material lot). Required |
material_lot | URI |
The URI of the material lot in which this container was created. If NULL - it is internal bureau container created via action 'batch_containerize'. Required |
quantity | float |
The current amount of the material in this container Required |
status | string |
Current status of the material container Required Choices
'"new|in_use|empty"'
|
sub_location | URI |
The URI of the containers’s sub_location Required |
uri | URI |
URI of the material container Required |
used_in_batches | array |
A list of material batches where container used before (in most cases there will be one value). Required Example: '["..."]'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested material_container cannot be found. |
This endpoint represents containers and it's usage in batches.
A container is part of a Material Lot
(as a root object, tracking starting state) and also a part of a material batch.
Container to Lot
relationships never change (maybe in the future this feature can be provided).
Container to Batch
relationship changes very often (via /material-batch-action/ API).
In many places, a material_container gets scanned, and the current material_batch that container is related to is brought up in the QR app to make changes to.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date the material container was created. |
current_batch | URI |
The URI of the batch which currently using this container. When there are no batches, created from the material lot, it can be equals to None. |
full_quantity | float |
The maximum (initial) amount of the material in this container |
is_available_for_initial_batches | boolean |
Is material containers can be used to create a new initial batch or not. |
location | URI |
The URI of the containers's location. |
material | URI |
The URI of the material in the container (we take it from the material lot). |
material_lot | URI |
The URI of the material lot in which this container was created. If NULL - it is internal bureau container created via action 'batch_containerize'. |
quantity | float |
The current amount of the material in this container |
status | string |
Current status of the material container Choices
'"new|in_use|empty"'
|
sub_location | URI |
The URI of the containers’s sub_location |
uri | URI |
URI of the material container |
used_in_batches | array |
A list of material batches where container used before (in most cases there will be one value). Example: '["..."]'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested material_container cannot be found. |
/material-genealogy/
Endpoint with slightly another implementation how another endpoints works.
Signature description is the same as for API /material-batch-linking/.
Schema (application/json)
Property | Type | Description |
---|---|---|
actions | array |
none available Example: ('[{"action_type": '
'"blend_batches|create_initial_batch|machine_unload_chamber|machine_unload_hopper|split_batch|add_container|containerize_batch|edit_batch_quantity|machine_load|machine_top_off|scrap_batch|sieve|test|relocate", '
'"metadata": null}]')
|
batches | array |
none available Example: ('[{"containers": ["..."], "materials": [{"units": "cm3|mm3|inch3|gram|kg|lb", '
'"cost": "100.00", "type": "support|base"}], "material_lots": ["..."], '
'"source_material_batches": ["..."], "status": "new|in_use|done", "units": '
'"cm3|mm3|inch3|gram|kg|lb"}]')
|
children_tree | array |
none available Example: '[{}]'
|
parents_tree | array |
none available Example: '[{}]'
|
target_batch | URI |
Target batch for which must be built and returned tree. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
actions | array |
none available Required Example: ('[{"action_type": '
'"blend_batches|create_initial_batch|machine_unload_chamber|machine_unload_hopper|split_batch|add_container|containerize_batch|edit_batch_quantity|machine_load|machine_top_off|scrap_batch|sieve|test|relocate", '
'"metadata": null}]')
|
batches | array |
none available Required Example: ('[{"containers": ["..."], "materials": [{"units": "cm3|mm3|inch3|gram|kg|lb", '
'"cost": "100.00", "type": "support|base"}], "material_lots": ["..."], '
'"source_material_batches": ["..."], "status": "new|in_use|done", "units": '
'"cm3|mm3|inch3|gram|kg|lb"}]')
|
children_tree | array |
none available Required Example: '[{}]'
|
parents_tree | array |
none available Required Example: '[{}]'
|
target_batch | URI |
Target batch for which must be built and returned tree. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
405 |
|
Endpoint with slightly another implementation how another endpoints works.
Signature description is the same as for API /material-batch-linking/.
Schema (application/json)
Property | Type | Description |
---|---|---|
actions | array |
none available Example: ('[{"action_type": '
'"blend_batches|create_initial_batch|machine_unload_chamber|machine_unload_hopper|split_batch|add_container|containerize_batch|edit_batch_quantity|machine_load|machine_top_off|scrap_batch|sieve|test|relocate", '
'"metadata": null}]')
|
batches | array |
none available Example: ('[{"containers": ["..."], "materials": [{"units": "cm3|mm3|inch3|gram|kg|lb", '
'"cost": "100.00", "type": "support|base"}], "material_lots": ["..."], '
'"source_material_batches": ["..."], "status": "new|in_use|done", "units": '
'"cm3|mm3|inch3|gram|kg|lb"}]')
|
children_tree | array |
none available Example: '[{}]'
|
parents_tree | array |
none available Example: '[{}]'
|
target_batch | URI |
Target batch for which must be built and returned tree. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
405 |
|
/material-lot-action/
This endpoint is called to log an action (for now - only add/edit/delete operations with unused material containers in a lot) on a material lot into the system.
This is a POST/GET/LIST only interface. PUT and DELETE is not allowed.
Schema (application/json)
Property | Type | Description |
---|---|---|
action_type | string |
The action type we want to take on the specified material lot. Choices
'"add_containers|edit_containers_quantity|delete_containers|receive_lot"'
|
created | iso-8601 datetime |
Datetime when material lot action was created (in UTC). |
material_lot | URI |
URI of the material lot to which the action applies. |
metadata | object |
Action specific JSON blob for action metadata. See METADATA_SIGNATURES for more details. Example: 'null'
|
notes | string |
Custom user description/notes for this action (required for 'receive_lot' action). |
uri | URI |
Material Lot Action's URI. |
user | URI |
A user whom performed an action |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
action_type | string |
The action type we want to take on the specified material lot. Required Choices
'"add_containers|edit_containers_quantity|delete_containers|receive_lot"'
|
created | iso-8601 datetime |
Datetime when material lot action was created (in UTC). Required |
material_lot | URI |
URI of the material lot to which the action applies. Required |
metadata | object |
Action specific JSON blob for action metadata. See METADATA_SIGNATURES for more details. Default: {} Example: 'null'
|
notes | string |
Custom user description/notes for this action (required for 'receive_lot' action). Required |
uri | URI |
Material Lot Action's URI. Required |
user | URI |
A user whom performed an action Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
|
This endpoint is called to log an action (for now - only add/edit/delete operations with unused material containers in a lot) on a material lot into the system.
This is a POST/GET/LIST only interface. PUT and DELETE is not allowed.
Schema (application/json)
Property | Type | Description |
---|---|---|
action_type | string |
The action type we want to take on the specified material lot. Choices
'"add_containers|edit_containers_quantity|delete_containers|receive_lot"'
|
created | iso-8601 datetime |
Datetime when material lot action was created (in UTC). |
material_lot | URI |
URI of the material lot to which the action applies. |
metadata | object |
Action specific JSON blob for action metadata. See METADATA_SIGNATURES for more details. Example: 'null'
|
notes | string |
Custom user description/notes for this action (required for 'receive_lot' action). |
uri | URI |
Material Lot Action's URI. |
user | URI |
A user whom performed an action |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
|
/material-lot/
MaterialLot is a special endpoint, that tracks the initial delivery group of material. A simple write-one data to indicate a group of material that has come in together as a single order. This is to track historical data or to connect together the data in material_batch, which updates very often.
It is not used much in the API, but is mostly treated as a write-once
place to indicate a delivery lot,
and to create material_containers, and a special initial-batch
of material_batch.
Schema (application/json)
Property | Type | Description |
---|---|---|
actual_delivery_date | iso-8601 datetime |
Datetime when material lot was delivered. |
containers_available_for_initial_batches | array |
List of URIs of the material containers which can be used to create new initial batch. Example: '["..."]'
|
cost | float |
Price per unit in bureau currency, for one unit of material.units. If not transferred - will be used material.cost. |
delivery_id | string |
Customer ID of the delivery |
estimated_delivery_date | iso-8601 datetime |
Datetime when material lot planned to be delivered. |
expiration_date | iso-8601 datetime |
Datetime after which usage of the material from the lot will be prohibited. |
full_quantity | float |
Sum of the full quantities in the material lot containers. |
initial_batches | array |
List of URIs of the initial batches created directly from the material lot. Example: '["..."]'
|
location | URI |
URI of Location in which material batches from this lot should be used. |
location_name | string |
Location name |
material | URI |
The material for the lot. |
material_name | string |
Name of material |
material_purchase_order | URI |
URI of an associated material purchase order. |
material_purchase_order_external_id | string |
A material purchase order external id (format customer defined). |
name | string |
Lot name. |
notes | string |
Notes for the material lot. |
number_of_containers | integer |
If non-zero on a POST, the count of material_container to create during the creation of DB resources. |
quantity | float |
Sum of current quantity in the material lot batches (current quantity in the material batch it is reserved_quantity (loaded into machine or in test) + quantity_available_for_actions (material which can be used for split, scrap_batch, and other actions)). |
size_of_container | float |
The amount of material in each container (from 'number_of_containers') in the material.units. |
status | string |
Status of the Material Lot. Initial Status (on material lot create) is limited by a set of allowed statuses: [on_order, received] Choices
'"on_order|received|in_testing|available|in_use|done|scrapped|return_to_supplier|in_storage"'
|
sub_location | URI |
The URI of the lot’s sub_location |
units | string |
Units of the material. Choices
'"cm3|mm3|inch3|gram|kg|lb"'
|
updated | iso-8601 datetime |
The date when the material lot was updated |
uri | URI |
The URI of this data entry. |
usage_cycles_limit | integer |
Allowed max number of use cycles. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Provided status transformation is not allowed. |
403 |
You are not authorized to complete the request. Modification of template material_lop not allowed via API. |
404 |
The requested material_lot cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
actual_delivery_date | iso-8601 datetime |
Datetime when material lot was delivered. Required |
containers_available_for_initial_batches | array |
List of URIs of the material containers which can be used to create new initial batch. Required Example: '["..."]'
|
cost | float |
Price per unit in bureau currency, for one unit of material.units. If not transferred - will be used material.cost. Required |
delivery_id | string |
Customer ID of the delivery Required |
estimated_delivery_date | iso-8601 datetime |
Datetime when material lot planned to be delivered. Required |
expiration_date | iso-8601 datetime |
Datetime after which usage of the material from the lot will be prohibited. Required |
full_quantity | float |
Sum of the full quantities in the material lot containers. Required |
initial_batches | array |
List of URIs of the initial batches created directly from the material lot. Required Example: '["..."]'
|
location | URI |
URI of Location in which material batches from this lot should be used. Required |
location_name | string |
Location name Required |
material | URI |
The material for the lot. Required |
material_name | string |
Name of material Required |
material_purchase_order | URI |
URI of an associated material purchase order. Required |
material_purchase_order_external_id | string |
A material purchase order external id (format customer defined). Required |
name | string |
Lot name. Required |
notes | string |
Notes for the material lot. Default: None |
number_of_containers | integer |
If non-zero on a POST, the count of material_container to create during the creation of DB resources. Required |
quantity | float |
Sum of current quantity in the material lot batches (current quantity in the material batch it is reserved_quantity (loaded into machine or in test) + quantity_available_for_actions (material which can be used for split, scrap_batch, and other actions)). Required |
size_of_container | float |
The amount of material in each container (from 'number_of_containers') in the material.units. Required |
status | string |
Status of the Material Lot. Initial Status (on material lot create) is limited by a set of allowed statuses: [on_order, received] Default: received Choices
'"on_order|received|in_testing|available|in_use|done|scrapped|return_to_supplier|in_storage"'
|
sub_location | URI |
The URI of the lot’s sub_location Required |
units | string |
Units of the material. Default: None Choices
'"cm3|mm3|inch3|gram|kg|lb"'
|
updated | iso-8601 datetime |
The date when the material lot was updated Required |
uri | URI |
The URI of this data entry. Required |
usage_cycles_limit | integer |
Allowed max number of use cycles. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Provided status transformation is not allowed. |
403 |
You are not authorized to complete the request. Modification of template material_lop not allowed via API. |
404 |
The requested material_lot cannot be found. |
MaterialLot is a special endpoint, that tracks the initial delivery group of material. A simple write-one data to indicate a group of material that has come in together as a single order. This is to track historical data or to connect together the data in material_batch, which updates very often.
It is not used much in the API, but is mostly treated as a write-once
place to indicate a delivery lot,
and to create material_containers, and a special initial-batch
of material_batch.
Schema (application/json)
Property | Type | Description |
---|---|---|
actual_delivery_date | iso-8601 datetime |
Datetime when material lot was delivered. |
containers_available_for_initial_batches | array |
List of URIs of the material containers which can be used to create new initial batch. Example: '["..."]'
|
cost | float |
Price per unit in bureau currency, for one unit of material.units. If not transferred - will be used material.cost. |
delivery_id | string |
Customer ID of the delivery |
estimated_delivery_date | iso-8601 datetime |
Datetime when material lot planned to be delivered. |
expiration_date | iso-8601 datetime |
Datetime after which usage of the material from the lot will be prohibited. |
full_quantity | float |
Sum of the full quantities in the material lot containers. |
initial_batches | array |
List of URIs of the initial batches created directly from the material lot. Example: '["..."]'
|
location | URI |
URI of Location in which material batches from this lot should be used. |
location_name | string |
Location name |
material | URI |
The material for the lot. |
material_name | string |
Name of material |
material_purchase_order | URI |
URI of an associated material purchase order. |
material_purchase_order_external_id | string |
A material purchase order external id (format customer defined). |
name | string |
Lot name. |
notes | string |
Notes for the material lot. |
number_of_containers | integer |
If non-zero on a POST, the count of material_container to create during the creation of DB resources. |
quantity | float |
Sum of current quantity in the material lot batches (current quantity in the material batch it is reserved_quantity (loaded into machine or in test) + quantity_available_for_actions (material which can be used for split, scrap_batch, and other actions)). |
size_of_container | float |
The amount of material in each container (from 'number_of_containers') in the material.units. |
status | string |
Status of the Material Lot. Initial Status (on material lot create) is limited by a set of allowed statuses: [on_order, received] Choices
'"on_order|received|in_testing|available|in_use|done|scrapped|return_to_supplier|in_storage"'
|
sub_location | URI |
The URI of the lot’s sub_location |
units | string |
Units of the material. Choices
'"cm3|mm3|inch3|gram|kg|lb"'
|
updated | iso-8601 datetime |
The date when the material lot was updated |
uri | URI |
The URI of this data entry. |
usage_cycles_limit | integer |
Allowed max number of use cycles. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Provided status transformation is not allowed. |
403 |
You are not authorized to complete the request. Modification of template material_lop not allowed via API. |
404 |
The requested material_lot cannot be found. |
/material-purchase-order/
Material Purchase Order represents a contract for delivering one or many Material Lots from a given company. This is MVP implementation of the feature. Focused on just overall amount of material in PO, and external ERP system ID tracking for now.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date when the material purchase order was created. |
delivered_quantity | float |
Delivered quantity/amount of material in the system as specific material_lots. |
external_id | string |
Purchase order ID (format customer defined). |
material | URI |
A material of a purchase order. |
material_name | string |
Name of a material. |
planned_full_quantity | float |
The total amount/quantity of a material (in material units) available under this PO. |
units | string |
Units of a material. |
updated | iso-8601 datetime |
The date when the purchase material order was updated. |
uri | URI |
The URI of material purchase order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
A material purchase order with requested PO Number (external_id) already exists (this field unique per bureau). |
403 |
You are not authorized to complete the request. |
404 |
The requested material_purchase_order cannot be found. |
405 |
Requested method not allowed/supported. |
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date when the material purchase order was created. Required |
delivered_quantity | float |
Delivered quantity/amount of material in the system as specific material_lots. Required |
external_id | string |
Purchase order ID (format customer defined). Required |
material | URI |
A material of a purchase order. Required |
material_name | string |
Name of a material. Required |
planned_full_quantity | float |
The total amount/quantity of a material (in material units) available under this PO. Required |
units | string |
Units of a material. Required |
updated | iso-8601 datetime |
The date when the purchase material order was updated. Required |
uri | URI |
The URI of material purchase order. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
A material purchase order with requested PO Number (external_id) already exists (this field unique per bureau). |
403 |
You are not authorized to complete the request. |
404 |
The requested material_purchase_order cannot be found. |
405 |
Requested method not allowed/supported. |
Material Purchase Order represents a contract for delivering one or many Material Lots from a given company. This is MVP implementation of the feature. Focused on just overall amount of material in PO, and external ERP system ID tracking for now.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date when the material purchase order was created. |
delivered_quantity | float |
Delivered quantity/amount of material in the system as specific material_lots. |
external_id | string |
Purchase order ID (format customer defined). |
material | URI |
A material of a purchase order. |
material_name | string |
Name of a material. |
planned_full_quantity | float |
The total amount/quantity of a material (in material units) available under this PO. |
units | string |
Units of a material. |
updated | iso-8601 datetime |
The date when the purchase material order was updated. |
uri | URI |
The URI of material purchase order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
A material purchase order with requested PO Number (external_id) already exists (this field unique per bureau). |
403 |
You are not authorized to complete the request. |
404 |
The requested material_purchase_order cannot be found. |
405 |
Requested method not allowed/supported. |
/material-test/instruction-report/
The material_test_instruction_report resource represents the numerical data captured by the tester performing the material-tests. Each test report has a 1-1 relationship with a material_test_instruction which tells the tester what data to measure and record in the report.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material_test_instruction_report belongs to |
material_test_instruction | URI |
The URI of test instruction that this report fulfils. 1:1 relationship to this record |
material_test_panel | URI |
The URI of material_test_panel that this report is a part of. Many reports per test panel. |
notes | string |
notes associated with the test report. |
unit | URI |
the uri for the unit type(km, inch, kg) of measurement that material_test_instruction_reports will be filled out in only units returned from API/units are allowed. |
uri | URI |
The URI of the material test instruction report |
value | float |
The numeric value measured by the material-tester following the directions specified in the material_test_instruction. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material test report cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material_test_instruction_report belongs to Required |
material_test_instruction | URI |
The URI of test instruction that this report fulfils. 1:1 relationship to this record Required |
material_test_panel | URI |
The URI of material_test_panel that this report is a part of. Many reports per test panel. Required |
notes | string |
notes associated with the test report. Required |
unit | URI |
the uri for the unit type(km, inch, kg) of measurement that material_test_instruction_reports will be filled out in only units returned from API/units are allowed. Required |
uri | URI |
The URI of the material test instruction report Required |
value | float |
The numeric value measured by the material-tester following the directions specified in the material_test_instruction. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested material test report cannot be found. |
The material_test_instruction_report resource represents the numerical data captured by the tester performing the material-tests. Each test report has a 1-1 relationship with a material_test_instruction which tells the tester what data to measure and record in the report.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material_test_instruction_report belongs to |
material_test_instruction | URI |
The URI of test instruction that this report fulfils. 1:1 relationship to this record |
material_test_panel | URI |
The URI of material_test_panel that this report is a part of. Many reports per test panel. |
notes | string |
notes associated with the test report. |
unit | URI |
the uri for the unit type(km, inch, kg) of measurement that material_test_instruction_reports will be filled out in only units returned from API/units are allowed. |
uri | URI |
The URI of the material test instruction report |
value | float |
The numeric value measured by the material-tester following the directions specified in the material_test_instruction. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material test report cannot be found. |
/material-test/instruction/
A Material Test Instruction is a description of one field that makes a test operation. Designed for Telling the tester what to measure as part of a test. For instance (complex case) for Material Composition Panel there could be one called "% hydrogen" and another called "% Iron". Maps 1:1 to a MaterialTestInstruction Report.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material test operation belongs to. |
description | string |
Description of the material test instruction. |
material_test_operation | URI |
The URI of the material test operation belongs to. |
material_work_checklist | URI |
The URI of the material test work checklist belongs to. |
name | string |
Name of the field describing the data to collect as part of the MaterialTestOperation Example: '"% hydrogen composition of sample"'
|
position | integer |
indexed position this has within the material_work_checklist.The Order of measurements to take as part of a material_test_operation. |
unit | URI |
the uri for the unit type(km, inch, kg) of measurement that material_test_instruction_reports will be filled out in only units returned from API/units are allowed. |
uri | URI |
The URI of the material-test-instruction. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material-test-instruction cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material test operation belongs to. Required |
description | string |
Description of the material test instruction. Required |
material_test_operation | URI |
The URI of the material test operation belongs to. Required |
material_work_checklist | URI |
The URI of the material test work checklist belongs to. Required |
name | string |
Name of the field describing the data to collect as part of the MaterialTestOperation Required Example: '"% hydrogen composition of sample"'
|
position | integer |
indexed position this has within the material_work_checklist.The Order of measurements to take as part of a material_test_operation. Default: 1 |
unit | URI |
the uri for the unit type(km, inch, kg) of measurement that material_test_instruction_reports will be filled out in only units returned from API/units are allowed. Required |
uri | URI |
The URI of the material-test-instruction. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested material-test-instruction cannot be found. |
A Material Test Instruction is a description of one field that makes a test operation. Designed for Telling the tester what to measure as part of a test. For instance (complex case) for Material Composition Panel there could be one called "% hydrogen" and another called "% Iron". Maps 1:1 to a MaterialTestInstruction Report.
Get a single instruction by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material test operation belongs to. |
description | string |
Description of the material test instruction. |
material_test_operation | URI |
The URI of the material test operation belongs to. |
material_work_checklist | URI |
The URI of the material test work checklist belongs to. |
name | string |
Name of the field describing the data to collect as part of the MaterialTestOperation Example: '"% hydrogen composition of sample"'
|
position | integer |
indexed position this has within the material_work_checklist.The Order of measurements to take as part of a material_test_operation. |
unit | URI |
the uri for the unit type(km, inch, kg) of measurement that material_test_instruction_reports will be filled out in only units returned from API/units are allowed. |
uri | URI |
The URI of the material-test-instruction. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material-test-instruction cannot be found. |
A material work checklist can be attached to many types of things in the system:: bureau, material, or a material_test_panel
This API is used for GET/LIST operations on work checklist linkings.
See API /material-test/work-checklists-for/ endpoint for creating work checklist linkings via PUT method
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material test operation linkings belongs to |
material_test_instructions | array |
List of all material_test_instructions that relate to this linking. Example: '["..."]'
|
material_test_operation | URI |
the uri of a specific material-test-operation within a material-work-checklist. |
material_work_checklist | URI |
the uri for the material-work-checklist. |
position | integer |
The position of the material-test-operation within the material work checklist |
related_uri | URL |
the uri defining the resource that this checklist is applied to. In order of specificity (bureau->material->panel) |
uri | URI |
The URI of the material test operation linking |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material-test-operation-linking cannot be found. |
A material work checklist can be attached to many types of things in the system:: bureau, material, or a material_test_panel
This API is used for GET/LIST operations on work checklist linkings.
See API /material-test/work-checklists-for/ endpoint for creating work checklist linkings via PUT method
Get a single material-test-operation by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material test operation linkings belongs to |
material_test_instructions | array |
List of all material_test_instructions that relate to this linking. Example: '["..."]'
|
material_test_operation | URI |
the uri of a specific material-test-operation within a material-work-checklist. |
material_work_checklist | URI |
the uri for the material-work-checklist. |
position | integer |
The position of the material-test-operation within the material work checklist |
related_uri | URL |
the uri defining the resource that this checklist is applied to. In order of specificity (bureau->material->panel) |
uri | URI |
The URI of the material test operation linking |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material-test-operation-linking cannot be found. |
/material-test/operation/
This resource represents a type of material test that can be included in material-test-panels for a particular bureau. This endpoint includes both custom and non-custom material-test-operations. Custom material-test-operations are any that have been created via the POST of this endpoint. Non-custom are added via Admin script.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
Date if archived and shouldn’t be shown in the UI. Otherwise this will be null. |
bureau | URI |
The URI of bureau the material test operation belongs to |
by_customer | URI |
If this was created by a bureau users, which user created this. If None, the operation was created by Authentise |
description | string |
Description of the material test operation. Example: '"Percentage by weight of each material in sample"'
|
name | string |
name of the material test operation. Example: '"Measure Density"'
|
unit | URI |
the uri for the unit type(km, inch, kg) of measurement that material_test_instruction_reports will be filled out in only units returned from API/units are allowed. |
uri | URI |
The URI of the material test operation |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material-test-operation cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
Date if archived and shouldn’t be shown in the UI. Otherwise this will be null. Required |
bureau | URI |
The URI of bureau the material test operation belongs to Required |
by_customer | URI |
If this was created by a bureau users, which user created this. If None, the operation was created by Authentise Required |
description | string |
Description of the material test operation. Required Example: '"Percentage by weight of each material in sample"'
|
name | string |
name of the material test operation. Required Example: '"Measure Density"'
|
unit | URI |
the uri for the unit type(km, inch, kg) of measurement that material_test_instruction_reports will be filled out in only units returned from API/units are allowed. Required |
uri | URI |
The URI of the material test operation Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested material-test-operation cannot be found. |
This resource represents a type of material test that can be included in material-test-panels for a particular bureau. This endpoint includes both custom and non-custom material-test-operations. Custom material-test-operations are any that have been created via the POST of this endpoint. Non-custom are added via Admin script.
Get a single material-test-operation by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
Date if archived and shouldn’t be shown in the UI. Otherwise this will be null. |
bureau | URI |
The URI of bureau the material test operation belongs to |
by_customer | URI |
If this was created by a bureau users, which user created this. If None, the operation was created by Authentise |
description | string |
Description of the material test operation. Example: '"Percentage by weight of each material in sample"'
|
name | string |
name of the material test operation. Example: '"Measure Density"'
|
unit | URI |
the uri for the unit type(km, inch, kg) of measurement that material_test_instruction_reports will be filled out in only units returned from API/units are allowed. |
uri | URI |
The URI of the material test operation |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material-test-operation cannot be found. |
/material-test/panel/
Panel resource represents a group of tests that we can perform on a sample. A sample being a small amount of material taken from a material-batch with the intention of performing material tests on it.
Each MaterialTestPanel can have one or many MaterialTestOperations. Each Operation can have multiple MaterialTestInstructions. Each MaterialTestInstruction can have only one MaterialTestReport
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material_test_panel belongs to |
completion_date | iso-8601 datetime |
the datetime representation of when the tester finished the last test in the panel |
material_test_reports | array |
List of all reports filled out so far for this specific panel Example: '["..."]'
|
name | string |
The name associated with the test panel |
sample | URI |
The URI of sample that this panel is being performed on. |
start_date | iso-8601 datetime |
the datetime representation of when the tester started started the first test in the panel |
uri | URI |
The URI of the material test panel |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material test panel cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material_test_panel belongs to Required |
completion_date | iso-8601 datetime |
the datetime representation of when the tester finished the last test in the panel Required |
material_test_reports | array |
List of all reports filled out so far for this specific panel Required Example: '["..."]'
|
name | string |
The name associated with the test panel Required |
sample | URI |
The URI of sample that this panel is being performed on. Required |
start_date | iso-8601 datetime |
the datetime representation of when the tester started started the first test in the panel Required |
uri | URI |
The URI of the material test panel Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested material test panel cannot be found. |
Panel resource represents a group of tests that we can perform on a sample. A sample being a small amount of material taken from a material-batch with the intention of performing material tests on it.
Each MaterialTestPanel can have one or many MaterialTestOperations. Each Operation can have multiple MaterialTestInstructions. Each MaterialTestInstruction can have only one MaterialTestReport
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the material_test_panel belongs to |
completion_date | iso-8601 datetime |
the datetime representation of when the tester finished the last test in the panel |
material_test_reports | array |
List of all reports filled out so far for this specific panel Example: '["..."]'
|
name | string |
The name associated with the test panel |
sample | URI |
The URI of sample that this panel is being performed on. |
start_date | iso-8601 datetime |
the datetime representation of when the tester started started the first test in the panel |
uri | URI |
The URI of the material test panel |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material test panel cannot be found. |
/material-test/unit/
This endpoint is currently used by material-test-panel feature. Resources listed by this endpoint are allowed to be used when creating material-test-operations.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the unit belongs to. |
description | string |
Description of the unit and how its measured. |
symbol | string |
Display name of unit |
uri | URI |
The URI of the material-test-unit. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material-test-unit cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the unit belongs to. Required |
description | string |
Description of the unit and how its measured. Default: None |
symbol | string |
Display name of unit Required |
uri | URI |
The URI of the material-test-unit. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested material-test-unit cannot be found. |
This endpoint is currently used by material-test-panel feature. Resources listed by this endpoint are allowed to be used when creating material-test-operations.
Get a single unit by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the unit belongs to. |
description | string |
Description of the unit and how its measured. |
symbol | string |
Display name of unit |
uri | URI |
The URI of the material-test-unit. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material-test-unit cannot be found. |
A material test work checklist has a 1-many relationship with a material-test and its purpose is to This endpoint isn't functional at this time. This is a placeholder and required to construct uris.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the work checklist belongs to |
uri | URI |
The URI of the material work checklist |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested material work checklist cannot be found. |
A material work checklist can be attached to many types of things in the system:: bureau, material, or a material_test_panel
This API is used for creating, updating and deleting work checklist linkings for specific objects via PUT method.
/material/
A material is the type of consumable that can be used to create objects. This includes thermoplastics, metal powders, foundry sand, etc. The material resource is used identify capabilities and type of material as well as allowing users to define what material they would like their finished products to be made from.
NOTE: This is not amount of material (that is stock , or material_batch, or material_lot).
NOTE: The "base_template" is a UUID of a parent template material, that may not be part of this bureau. the DB we cut/pasted into the bureau so we have a local copy of it.
Material can also be used in tracking stock usage and supply
List all of the materials in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
base_template | URI |
Indicates the URI of Material (from the shared library with |
bureau | URI |
The URI of the material's bureau. |
color | string |
HEX Color of the material. Example: (#000000) |
color_opacity | float |
A value between 0.00 (fully transparent) and 1.00 (fully opaque) that represents the color's opacity. Returns data only to 2 decimal places. |
cost | float |
The cost of the material per 'units'. |
custom_field_values | array |
none available Example: '[{}]'
|
density | float |
The density of the material is grams/cm^3. Required if units is by weight |
description | string |
The description of the material |
external_datasheet_url | URL |
URL on remote documentation about material. |
external_id | string |
The unique ID of this material in the customers ERP system. Can be a URI |
identifiers | array |
Identifier for a material instance. It contains bureau, material ID and finish ID. Example: '[{}]'
|
is_prosper_integration_available | boolean |
none available |
is_template | boolean |
Indicates, that this |
manufacturer | URI |
The URI of the material's manufacturer. |
manufacturing_process | string |
Additive Manufacturing process in which this material can be used. Choices
('"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet '
'Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL|SLM_DMLS|LCD SLA"')
|
material_family | string |
Class of the material by structure. Choices
'"Priority|Polymer|Composite|Metal|Ceramic|Wax|Sand"'
|
name | string |
The name of the material |
post_processing_seconds | integer |
Post processing time of the material in seconds. |
stock_locations | array |
The list of all locations with stock of this material available at them. Example: '["..."]'
|
swatch | URL |
Image of the /material/ instance Example: '"https://external-url.com/img/materials/swatch-pla.png"'
|
third_party_fulfillment | boolean |
Post processing of the material in seconds. Choices
'"True|False"'
|
thumbnail | object |
none available Example: '{}'
|
type | string |
Type of the material. Choices
'"support|base"'
|
units | string |
Unit of the stock, user-specified. Choices
'"cm3|mm3|inch3|gram|kg|lb"'
|
units_measurement_core | string |
Core of units (Weight or Volume) Can't be change by users. Choices
'"weight|volume"'
|
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
You cannot delete this material because there are stocks or orders associated with it. Delete all orders and stocks using this material first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The requested material name already exists. |
403 |
You are not authorized to complete the request. Modification of template material not allowed via API. |
404 |
The requested material cannot be found. |
Create a new material.
After a new material is created a X-Upload-Location header will be returned. Using this allows us to upload a thumbnail for the material that was created. Use the X-Upload-Location header to PUT file contents to that location.
Example:
curl -X PUT -H 'Content-Type: image/png' --data-binary '@PATH-TO-YOUR-PNG' "<HEADER X-UPLOAD-LOCATION>"
Schema (application/json)
Property | Type | Description |
---|---|---|
base_template | URI |
Indicates the URI of Material (from the shared library with Required |
bureau | URI |
The URI of the material's bureau. Required |
color | string |
HEX Color of the material. Example: (#000000) Required |
color_opacity | float |
A value between 0.00 (fully transparent) and 1.00 (fully opaque) that represents the color's opacity. Returns data only to 2 decimal places. Default: 1.0 |
cost | float |
The cost of the material per 'units'. Required |
custom_field_values | array |
none available Default: None Example: '[{}]'
|
density | float |
The density of the material is grams/cm^3. Required if units is by weight Default: None |
description | string |
The description of the material Required |
external_datasheet_url | URL |
URL on remote documentation about material. Default: None |
external_id | string |
The unique ID of this material in the customers ERP system. Can be a URI Default: None |
identifiers | array |
Identifier for a material instance. It contains bureau, material ID and finish ID. Default: [] Example: '[{}]'
|
is_prosper_integration_available | boolean |
none available Default: False |
is_template | boolean |
Indicates, that this Required |
manufacturer | URI |
The URI of the material's manufacturer. Required |
manufacturing_process | string |
Additive Manufacturing process in which this material can be used. Default: None Choices
('"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet '
'Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL|SLM_DMLS|LCD SLA"')
|
material_family | string |
Class of the material by structure. Default: None Choices
'"Priority|Polymer|Composite|Metal|Ceramic|Wax|Sand"'
|
name | string |
The name of the material Required |
post_processing_seconds | integer |
Post processing time of the material in seconds. Default: 0 |
stock_locations | array |
The list of all locations with stock of this material available at them. Required Example: '["..."]'
|
swatch | URL |
Image of the /material/ instance Default: None Example: '"https://external-url.com/img/materials/swatch-pla.png"'
|
third_party_fulfillment | boolean |
Post processing of the material in seconds. Required Choices
'"True|False"'
|
thumbnail | object |
none available Default: None Example: '{}'
|
type | string |
Type of the material. Required Choices
'"support|base"'
|
units | string |
Unit of the stock, user-specified. Default: cm3 Choices
'"cm3|mm3|inch3|gram|kg|lb"'
|
units_measurement_core | string |
Core of units (Weight or Volume) Can't be change by users. Default: volume Choices
'"weight|volume"'
|
uri | URI |
none available Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
You cannot delete this material because there are stocks or orders associated with it. Delete all orders and stocks using this material first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The requested material name already exists. |
403 |
You are not authorized to complete the request. Modification of template material not allowed via API. |
404 |
The requested material cannot be found. |
/material//clone/
Clone Material to the bureau level from the template (shared) Material
Schema (application/json)
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested material type cannot be found. |
A material is the type of consumable that can be used to create objects. This includes thermoplastics, metal powders, foundry sand, etc. The material resource is used identify capabilities and type of material as well as allowing users to define what material they would like their finished products to be made from.
NOTE: This is not amount of material (that is stock , or material_batch, or material_lot).
NOTE: The "base_template" is a UUID of a parent template material, that may not be part of this bureau. the DB we cut/pasted into the bureau so we have a local copy of it.
Material can also be used in tracking stock usage and supply
Get a single material by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
base_template | URI |
Indicates the URI of Material (from the shared library with |
bureau | URI |
The URI of the material's bureau. |
color | string |
HEX Color of the material. Example: (#000000) |
color_opacity | float |
A value between 0.00 (fully transparent) and 1.00 (fully opaque) that represents the color's opacity. Returns data only to 2 decimal places. |
cost | float |
The cost of the material per 'units'. |
custom_field_values | array |
none available Example: '[{}]'
|
density | float |
The density of the material is grams/cm^3. Required if units is by weight |
description | string |
The description of the material |
external_datasheet_url | URL |
URL on remote documentation about material. |
external_id | string |
The unique ID of this material in the customers ERP system. Can be a URI |
identifiers | array |
Identifier for a material instance. It contains bureau, material ID and finish ID. Example: '[{}]'
|
is_prosper_integration_available | boolean |
none available |
is_template | boolean |
Indicates, that this |
manufacturer | URI |
The URI of the material's manufacturer. |
manufacturing_process | string |
Additive Manufacturing process in which this material can be used. Choices
('"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet '
'Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL|SLM_DMLS|LCD SLA"')
|
material_family | string |
Class of the material by structure. Choices
'"Priority|Polymer|Composite|Metal|Ceramic|Wax|Sand"'
|
name | string |
The name of the material |
post_processing_seconds | integer |
Post processing time of the material in seconds. |
stock_locations | array |
The list of all locations with stock of this material available at them. Example: '["..."]'
|
swatch | URL |
Image of the /material/ instance Example: '"https://external-url.com/img/materials/swatch-pla.png"'
|
third_party_fulfillment | boolean |
Post processing of the material in seconds. Choices
'"True|False"'
|
thumbnail | object |
none available Example: '{}'
|
type | string |
Type of the material. Choices
'"support|base"'
|
units | string |
Unit of the stock, user-specified. Choices
'"cm3|mm3|inch3|gram|kg|lb"'
|
units_measurement_core | string |
Core of units (Weight or Volume) Can't be change by users. Choices
'"weight|volume"'
|
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
You cannot delete this material because there are stocks or orders associated with it. Delete all orders and stocks using this material first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The requested material name already exists. |
403 |
You are not authorized to complete the request. Modification of template material not allowed via API. |
404 |
The requested material cannot be found. |
/memberships/
This is some legacy stuff which in most cases should be or removed or used only internally
(currently, it used in create_bureau
script - which is not the best decision).
PUT, POST and DELETE methods requires permission nautilus.constants.GROUP_ADMIN_RIGHT
and this should be enough
to protect this methods (bureau manager should use API /role/ instead).
GET and LIST methods potentially dangerous - that why we restrict access to memberships only to current user.
Schema (application/json)
Property | Type | Description |
---|---|---|
group | URI |
none available |
uri | URI |
none available |
user | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
group | URI |
none available Required |
uri | URI |
none available Default: None |
user | URI |
none available Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is some legacy stuff which in most cases should be or removed or used only internally
(currently, it used in create_bureau
script - which is not the best decision).
PUT, POST and DELETE methods requires permission nautilus.constants.GROUP_ADMIN_RIGHT
and this should be enough
to protect this methods (bureau manager should use API /role/ instead).
GET and LIST methods potentially dangerous - that why we restrict access to memberships only to current user.
Schema (application/json)
Property | Type | Description |
---|---|---|
group | URI |
none available |
uri | URI |
none available |
user | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/merge/
Layout and Position data are used to run a merge
to create a build-file. This endpoint reports
that status of the merge action.
Before ch28083 this API was used in the chain of internal calls (it was a part of micro-services architecture in ~2015-2017).
Create a new merge.
Schema (application/json)
Property | Type | Description |
---|---|---|
build_file | URI |
Build file URI Default: None |
created | iso-8601 datetime |
The time of creation of merge instance. Default: None |
description | string |
Description of merge model Default: None |
name | string |
Name of merge model. Required |
uri | URI |
Merge URI Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested layout cannot be found. |
/merge/{uuid}/
Layout and Position data are used to run a merge
to create a build-file. This endpoint reports
that status of the merge action.
Before ch28083 this API was used in the chain of internal calls (it was a part of micro-services architecture in ~2015-2017).
Get a single merge by uuid.
Schema (application/json)
Property | Type | Description |
---|---|---|
build_file | URI |
Build file URI |
created | iso-8601 datetime |
The time of creation of merge instance. |
description | string |
Description of merge model |
name | string |
Name of merge model. |
uri | URI |
Merge URI |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested layout cannot be found. |
Custom API that processes/takes messages from Cichlid microservice about Model Cad Conversion process.
We are sending this URI in a payload to Cichlid and expect that Cichlid will publishing updates (status change, notes, and resulting STL file on success) to this API.
Note: Supports only auth by API_TOKEN constants (marker for the function "is_api_user").
Schema (application/json)
Property | Type | Description |
---|---|---|
notes | string |
Additional notes or error related to the conversion process. Required |
status | string |
Status of the Cichlid conversion process. Required Choices
'"scheduled|processing|processed|error"'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested feature cannot be found. |
/model-library/
This is a feature to keep track some relationships between models, workflows, and related info that we will want when re-using a model.
Example uses: Marking some models as 'samples' to use a a testing object to add to builds. Marking a whole build volume and workflow to re-use complete build volumes. Marking a print that does very well in a certain workflow, to find an use it again.
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Example: '{}'
|
created | iso-8601 datetime |
The date when the Model Library was created. |
custom_field_values | array |
none available Example: '[{}]'
|
default_customer_id | string |
Human readable alpha-numeric, customer defined ID |
labels | array |
list of label uris related to the model-library Example: '["..."]'
|
name | string |
The name of the model library. |
notes | string |
The description of the Model Library. |
owner | URL |
The user, bureau, or group that can edit (or view, for some bureaus) this item. |
type | string |
Choices
'"product|specimen|waste|tooling"'
|
updated | iso-8601 datetime |
The date when the Model Library was updated |
uri | URI |
The Model Library URI. |
workflow | URI |
The URI of workflow. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
create a new model-library entry. must have an existing item.
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Default: {} Example: '{}'
|
created | iso-8601 datetime |
The date when the Model Library was created. Default: None |
custom_field_values | array |
none available Default: None Example: '[{}]'
|
default_customer_id | string |
Human readable alpha-numeric, customer defined ID Default: None |
labels | array |
list of label uris related to the model-library Default: [] Example: '["..."]'
|
name | string |
The name of the model library. Required |
notes | string |
The description of the Model Library. Default: None |
owner | URL |
The user, bureau, or group that can edit (or view, for some bureaus) this item. Required |
type | string |
Required Choices
'"product|specimen|waste|tooling"'
|
updated | iso-8601 datetime |
The date when the Model Library was updated Default: None |
uri | URI |
The Model Library URI. Required |
workflow | URI |
The URI of workflow. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
|
404 |
|
This is a feature to keep track some relationships between models, workflows, and related info that we will want when re-using a model.
Example uses: Marking some models as 'samples' to use a a testing object to add to builds. Marking a whole build volume and workflow to re-use complete build volumes. Marking a print that does very well in a certain workflow, to find an use it again.
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Example: '{}'
|
created | iso-8601 datetime |
The date when the Model Library was created. |
custom_field_values | array |
none available Example: '[{}]'
|
default_customer_id | string |
Human readable alpha-numeric, customer defined ID |
labels | array |
list of label uris related to the model-library Example: '["..."]'
|
name | string |
The name of the model library. |
notes | string |
The description of the Model Library. |
owner | URL |
The user, bureau, or group that can edit (or view, for some bureaus) this item. |
type | string |
Choices
'"product|specimen|waste|tooling"'
|
updated | iso-8601 datetime |
The date when the Model Library was updated |
uri | URI |
The Model Library URI. |
workflow | URI |
The URI of workflow. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
/model/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
action | string |
none available Choices
'"mesh_heal_via_Authentise|processing_mesh_heal_via_Authentise"'
|
allowed_transformations | object |
none available Example: '{}'
|
analyses | object |
status of manifold and count of inverted surface triangles Example: '{}'
|
auto-align | boolean |
none available |
callback | object |
none available Example: '{}'
|
children | array |
none available Example: '["..."]'
|
content | string |
Download to raw model content. Data format matches 'type'. |
conversion_notes | string |
Notes for the conversion process. |
conversion_original_content | string |
Link to binary content of pre-conversion file, if exists |
conversion_original_filename | string |
Filename of source native file |
conversion_original_type | string |
Type of input native file to send to X-Upload and for conversion_original_content Choices
'"x_t|xt|sat|step|stp|igs|iges|sldprt|ipt|prt|catpart|jt|j_t|3dm|obj|iam|dae|pdf|png|tiff|tif"'
|
conversion_status | string |
Sub-Status of conversion process if status is conversion Choices
'"new|pending|downloading|repairing|processing|uploading|complete|complete-without-upload|failed"'
|
created | iso-8601 datetime |
none available |
design_file | URI |
If directly unpacked from a design file (1:1) the URI of that design_file. Otherwise null. |
file_size | integer |
none available |
file_unit | string |
The default unit of the model file (inch, mm). Set null to allow autodetect. Choices
'"in|mm|cm|m|feet"'
|
manufacturing_orientation | object |
Manufacturing XYZ rotations of the model associated to this line-item, set by the user to control the structural robustness of the line item during the additive manufacturing step - not to be confused with the final position (transformation) on the build plate, which is instead set by the packing system. Example: '{"status": "in_queue|in_progress|error|uploaded"}'
|
mfg_oriented_content | string |
Download the mfg-oriented model's content. Data format matches 'type'. |
name | string |
Name of the model. Cannot exceed 255 characters. |
parents | array |
none available Example: '["..."]'
|
polygons | integer |
none available |
replaced_models | array |
List of model URIs of all models that were replaced from a line_item, leading to the current model. Sorted from most recently replaced model to the oldest replaced model. Note: we dont return this field in LIST response because it requires expensive db operations and data is not needed for LIST at the moment Example: '["..."]'
|
rights | array |
none available Example: '["all|download|print|transform|transform-external|view"]'
|
size | object |
We use mm internally and front-end logic converts to user_unit Example: '{}'
|
snapshot | string |
none available |
snapshot_content | string |
none available |
status | string |
none available Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
surface_area_mm | float |
The surface area is in mm as unit at API level, not in user_units. |
type | string |
Format of data we will post to X-Upload-Location. Choices
'"stl"'
|
updated | iso-8601 datetime |
none available |
upload-location | string |
none available |
uri | URI |
none available |
user_unit | string |
Model files can have their units (file_units) and users can also specify units to read this API data. Internal data is always in MM, this changes API presentation of data only. We strongly encourage using the default of mm. Choices
'"in|mm"'
|
user_uri | URI |
none available |
virus_scan | string |
State of the virus-scan on the file pushed to X-Upload-Location. Quarantined indicates a problem was detected. Choices
'"unscanned|passed|quarantined"'
|
volume_mm | float |
The volume is in mm as unit at API level, not in user_units. |
zverse_conversion | URI |
ZVerse conversion URI (if model conversion was delegated to the ZVerse service). |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
401 |
|
Create a new model.
NOTE: Most 'model' updates should be done by creating a new model. See docs.authentise.com or PlatformModel code for more details.
Schema (application/json)
Property | Type | Description |
---|---|---|
action | string |
none available Default: None Choices
'"mesh_heal_via_Authentise|processing_mesh_heal_via_Authentise"'
|
allowed_transformations | object |
none available Default: {'resize': False, 'rotation': False} Example: '{}'
|
analyses | object |
status of manifold and count of inverted surface triangles Default: None Example: '{}'
|
auto-align | boolean |
none available Default: None |
callback | object |
none available Default: None Example: '{}'
|
children | array |
none available Default: [] Example: '["..."]'
|
content | string |
Download to raw model content. Data format matches 'type'. Default: None |
conversion_notes | string |
Notes for the conversion process. Required |
conversion_original_content | string |
Link to binary content of pre-conversion file, if exists Required |
conversion_original_filename | string |
Filename of source native file Default: None |
conversion_original_type | string |
Type of input native file to send to X-Upload and for conversion_original_content Default: None Choices
'"x_t|xt|sat|step|stp|igs|iges|sldprt|ipt|prt|catpart|jt|j_t|3dm|obj|iam|dae|pdf|png|tiff|tif"'
|
conversion_status | string |
Sub-Status of conversion process if status is conversion Required Choices
'"new|pending|downloading|repairing|processing|uploading|complete|complete-without-upload|failed"'
|
created | iso-8601 datetime |
none available Default: None |
design_file | URI |
If directly unpacked from a design file (1:1) the URI of that design_file. Otherwise null. Required |
file_size | integer |
none available Default: None |
file_unit | string |
The default unit of the model file (inch, mm). Set null to allow autodetect. Default: mm Choices
'"in|mm|cm|m|feet"'
|
manufacturing_orientation | object |
Manufacturing XYZ rotations of the model associated to this line-item, set by the user to control the structural robustness of the line item during the additive manufacturing step - not to be confused with the final position (transformation) on the build plate, which is instead set by the packing system. Default: None Example: '{"status": "in_queue|in_progress|error|uploaded"}'
|
mfg_oriented_content | string |
Download the mfg-oriented model's content. Data format matches 'type'. Default: None |
name | string |
Name of the model. Cannot exceed 255 characters. Required |
parents | array |
none available Default: [] Example: '["..."]'
|
polygons | integer |
none available Default: None |
replaced_models | array |
List of model URIs of all models that were replaced from a line_item, leading to the current model. Sorted from most recently replaced model to the oldest replaced model. Note: we dont return this field in LIST response because it requires expensive db operations and data is not needed for LIST at the moment Default: [] Example: '["..."]'
|
rights | array |
none available Default: None Example: '["all|download|print|transform|transform-external|view"]'
|
size | object |
We use mm internally and front-end logic converts to user_unit Default: None Example: '{}'
|
snapshot | string |
none available Default: None |
snapshot_content | string |
none available Default: None |
status | string |
none available Default: None Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
surface_area_mm | float |
The surface area is in mm as unit at API level, not in user_units. Default: None |
type | string |
Format of data we will post to X-Upload-Location. Required Choices
'"stl"'
|
updated | iso-8601 datetime |
none available Default: None |
upload-location | string |
none available Default: None |
uri | URI |
none available Default: None |
user_unit | string |
Model files can have their units (file_units) and users can also specify units to read this API data. Internal data is always in MM, this changes API presentation of data only. We strongly encourage using the default of mm. Default: mm Choices
'"in|mm"'
|
user_uri | URI |
none available Default: None |
virus_scan | string |
State of the virus-scan on the file pushed to X-Upload-Location. Quarantined indicates a problem was detected. Default: unscanned Choices
'"unscanned|passed|quarantined"'
|
volume_mm | float |
The volume is in mm as unit at API level, not in user_units. Default: None |
zverse_conversion | URI |
ZVerse conversion URI (if model conversion was delegated to the ZVerse service). Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
401 |
|
/model//snapshot/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
callback | object |
none available Example: '{"method": "GET|POST|PUT"}'
|
color | string |
RGB for a your snapshots for base_material, including # sign at the start. Auth Orange default |
content | string |
none available |
created | iso-8601 datetime |
none available |
height | integer |
none available |
model | URI |
none available |
model_status | string |
none available Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
samples | integer |
none available |
slice_height | float |
none available |
status | string |
none available Choices
'"in_queue|rendering|error|rendered"'
|
u | float |
none available |
uri | URI |
none available |
v | float |
none available |
w | float |
none available |
width | integer |
none available |
x | float |
none available |
y | float |
none available |
z | float |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
callback | object |
none available Default: None Example: '{"method": "GET|POST|PUT"}'
|
color | string |
RGB for a your snapshots for base_material, including # sign at the start. Auth Orange defaultDefault: #FF7F00 |
content | string |
none available Default: None |
created | iso-8601 datetime |
none available Default: None |
height | integer |
none available Default: 480 |
model | URI |
none available Default: None |
model_status | string |
none available Default: None Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
samples | integer |
none available Default: 10 |
slice_height | float |
none available Default: None |
status | string |
none available Default: None Choices
'"in_queue|rendering|error|rendered"'
|
u | float |
none available Default: None |
uri | URI |
none available Default: None |
v | float |
none available Default: None |
w | float |
none available Default: None |
width | integer |
none available Default: 640 |
x | float |
none available Default: None |
y | float |
none available Default: None |
z | float |
none available Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
/model//snapshot/binary/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
callback | object |
none available Example: '{"method": "GET|POST|PUT"}'
|
color | string |
RGB for a your snapshots for base_material, including # sign at the start. Auth Orange default |
content | string |
none available |
created | iso-8601 datetime |
none available |
height | integer |
none available |
model | URI |
none available |
model_status | string |
none available Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
samples | integer |
none available |
slice_height | float |
none available |
status | string |
none available Choices
'"in_queue|rendering|error|rendered"'
|
u | float |
none available |
uri | URI |
none available |
v | float |
none available |
w | float |
none available |
width | integer |
none available |
x | float |
none available |
y | float |
none available |
z | float |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
callback | object |
none available Default: None Example: '{"method": "GET|POST|PUT"}'
|
color | string |
RGB for a your snapshots for base_material, including # sign at the start. Auth Orange defaultDefault: #FF7F00 |
content | string |
none available Default: None |
created | iso-8601 datetime |
none available Default: None |
height | integer |
none available Default: 480 |
model | URI |
none available Default: None |
model_status | string |
none available Default: None Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
samples | integer |
none available Default: 10 |
slice_height | float |
none available Default: None |
status | string |
none available Default: None Choices
'"in_queue|rendering|error|rendered"'
|
u | float |
none available Default: None |
uri | URI |
none available Default: None |
v | float |
none available Default: None |
w | float |
none available Default: None |
width | integer |
none available Default: 640 |
x | float |
none available Default: None |
y | float |
none available Default: None |
z | float |
none available Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
callback | object |
none available Example: '{"method": "GET|POST|PUT"}'
|
color | string |
RGB for a your snapshots for base_material, including # sign at the start. Auth Orange default |
content | string |
none available |
created | iso-8601 datetime |
none available |
height | integer |
none available |
model | URI |
none available |
model_status | string |
none available Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
samples | integer |
none available |
slice_height | float |
none available |
status | string |
none available Choices
'"in_queue|rendering|error|rendered"'
|
u | float |
none available |
uri | URI |
none available |
v | float |
none available |
w | float |
none available |
width | integer |
none available |
x | float |
none available |
y | float |
none available |
z | float |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
callback | object |
none available Example: '{"method": "GET|POST|PUT"}'
|
color | string |
RGB for a your snapshots for base_material, including # sign at the start. Auth Orange default |
content | string |
none available |
created | iso-8601 datetime |
none available |
height | integer |
none available |
model | URI |
none available |
model_status | string |
none available Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
samples | integer |
none available |
slice_height | float |
none available |
status | string |
none available Choices
'"in_queue|rendering|error|rendered"'
|
u | float |
none available |
uri | URI |
none available |
v | float |
none available |
w | float |
none available |
width | integer |
none available |
x | float |
none available |
y | float |
none available |
z | float |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Creat a new model
Schema (application/json)
Property | Type | Description |
---|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
/model/{uuid}/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
action | string |
none available Choices
'"mesh_heal_via_Authentise|processing_mesh_heal_via_Authentise"'
|
allowed_transformations | object |
none available Example: '{}'
|
analyses | object |
status of manifold and count of inverted surface triangles Example: '{}'
|
auto-align | boolean |
none available |
callback | object |
none available Example: '{}'
|
children | array |
none available Example: '["..."]'
|
content | string |
Download to raw model content. Data format matches 'type'. |
conversion_notes | string |
Notes for the conversion process. |
conversion_original_content | string |
Link to binary content of pre-conversion file, if exists |
conversion_original_filename | string |
Filename of source native file |
conversion_original_type | string |
Type of input native file to send to X-Upload and for conversion_original_content Choices
'"x_t|xt|sat|step|stp|igs|iges|sldprt|ipt|prt|catpart|jt|j_t|3dm|obj|iam|dae|pdf|png|tiff|tif"'
|
conversion_status | string |
Sub-Status of conversion process if status is conversion Choices
'"new|pending|downloading|repairing|processing|uploading|complete|complete-without-upload|failed"'
|
created | iso-8601 datetime |
none available |
design_file | URI |
If directly unpacked from a design file (1:1) the URI of that design_file. Otherwise null. |
file_size | integer |
none available |
file_unit | string |
The default unit of the model file (inch, mm). Set null to allow autodetect. Choices
'"in|mm|cm|m|feet"'
|
manufacturing_orientation | object |
Manufacturing XYZ rotations of the model associated to this line-item, set by the user to control the structural robustness of the line item during the additive manufacturing step - not to be confused with the final position (transformation) on the build plate, which is instead set by the packing system. Example: '{"status": "in_queue|in_progress|error|uploaded"}'
|
mfg_oriented_content | string |
Download the mfg-oriented model's content. Data format matches 'type'. |
name | string |
Name of the model. Cannot exceed 255 characters. |
parents | array |
none available Example: '["..."]'
|
polygons | integer |
none available |
replaced_models | array |
List of model URIs of all models that were replaced from a line_item, leading to the current model. Sorted from most recently replaced model to the oldest replaced model. Note: we dont return this field in LIST response because it requires expensive db operations and data is not needed for LIST at the moment Example: '["..."]'
|
rights | array |
none available Example: '["all|download|print|transform|transform-external|view"]'
|
size | object |
We use mm internally and front-end logic converts to user_unit Example: '{}'
|
snapshot | string |
none available |
snapshot_content | string |
none available |
status | string |
none available Choices
'"not-uploaded|converting|processing|processed|external-process|error|repaired|irreparable|inoperable|file-too-large"'
|
surface_area_mm | float |
The surface area is in mm as unit at API level, not in user_units. |
type | string |
Format of data we will post to X-Upload-Location. Choices
'"stl"'
|
updated | iso-8601 datetime |
none available |
upload-location | string |
none available |
uri | URI |
none available |
user_unit | string |
Model files can have their units (file_units) and users can also specify units to read this API data. Internal data is always in MM, this changes API presentation of data only. We strongly encourage using the default of mm. Choices
'"in|mm"'
|
user_uri | URI |
none available |
virus_scan | string |
State of the virus-scan on the file pushed to X-Upload-Location. Quarantined indicates a problem was detected. Choices
'"unscanned|passed|quarantined"'
|
volume_mm | float |
The volume is in mm as unit at API level, not in user_units. |
zverse_conversion | URI |
ZVerse conversion URI (if model conversion was delegated to the ZVerse service). |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
401 |
|
/modeler-type/
Get information about the different supported modeler-types (printer models)
Get list of modeler-types. Supports filters
Schema (application/json)
Property | Type | Description |
---|---|---|
capture_types | array |
The capture_types associated with this modeler-type Example: ('[{"capture_type": '
'"arcam.job.log|catex.modeler.jobs|catex.modeler.status|connex.modeler.log|eos_connect.modeler.log|eos.modeler.log|hp.modeler.status|slm.modeler.status|projet660.modeler.log|ultimaker.modeler.log|stratasys.connectivity.modeler.status|stratasys.connectivity.modeler.historic|carbon3D.modeler.status|formlabs.modeler.status|markforged.modeler.status|renishaw.modeler.log|renishaw.modeler.historic|photocentric.modeler.status"}]')
|
description | string |
A short description of the modeler-type |
manufacturer | string |
The the manufacturer of the modeler |
name | string |
The name/model number of the represented modeler (printer). |
technology | string |
The 3d printing technology the modeler can use. Choices
('"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet '
'Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL|SLM_DMLS|LCD SLA"')
|
uri | URI |
The URI to the modeler-type |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
|
Get information about the different supported modeler-types (printer models)
Get a modeler-type by uuid
Schema (application/json)
Property | Type | Description |
---|---|---|
capture_types | array |
The capture_types associated with this modeler-type Example: ('[{"capture_type": '
'"arcam.job.log|catex.modeler.jobs|catex.modeler.status|connex.modeler.log|eos_connect.modeler.log|eos.modeler.log|hp.modeler.status|slm.modeler.status|projet660.modeler.log|ultimaker.modeler.log|stratasys.connectivity.modeler.status|stratasys.connectivity.modeler.historic|carbon3D.modeler.status|formlabs.modeler.status|markforged.modeler.status|renishaw.modeler.log|renishaw.modeler.historic|photocentric.modeler.status"}]')
|
description | string |
A short description of the modeler-type |
manufacturer | string |
The the manufacturer of the modeler |
name | string |
The name/model number of the represented modeler (printer). |
technology | string |
The 3d printing technology the modeler can use. Choices
('"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet '
'Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL|SLM_DMLS|LCD SLA"')
|
uri | URI |
The URI to the modeler-type |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
|
/modeler/
Create and update modelers, and get information about them
Get list of modelers with optional filters
Schema (application/json)
Property | Type | Description |
---|---|---|
cassettes | array |
none available Example: '["..."]'
|
connected | boolean |
True if we are able to communicate with the printer, false otherwise. When this property is set to 'false' the status of the modeler will be changed to 'offline' until 'connected' is set back to 'true'. This will even take precedence over error states. This property is normally used by API managed modelers |
current_build | URI |
The current build the modeler is processing |
description | string |
A short description about this modeler |
error | string |
Detailed error status on the modeler, if any. |
history_collection_frequency | string |
The frequency of collecting the modeler's historic jobs Choices
'"daily|monthly|never"'
|
ip_address | string |
The local ip address of the modeler, as a string. Supports both IPv4 and IPv6 |
latest_upload | iso-8601 datetime |
The last date and time a capture was uploaded for this modeler |
name | string |
The name of the modeler |
password | string |
The password for corresponding username to communicate with certain machines. It's only used for EOSConnect modeler. |
serial_number | string |
The serial number of the modeler, as a string |
status | string |
The status of the modeler, or what it's doing. This cannot be directly changed Choices
'"not_connected|error|idle|offline|printing|maintenance|print_finished|ready_to_print|unknown"'
|
type | URI |
The URI to the modeler type of this modeler |
updated | iso-8601 datetime |
none available |
uri | URI |
The URI to the modeler |
username | string |
Special username required to communicate with certain machines. It's only used for EOSConnect modeler. |
watermark | string |
Marks the reference to the latest historic build collected |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
This means the IP address you entered is invalid. Make sure your ip address is a valid IPv4 or IPv6 address. |
404 |
|
Create a new modeler
Schema (application/json)
Property | Type | Description |
---|---|---|
cassettes | array |
none available Required Example: '["..."]'
|
connected | boolean |
True if we are able to communicate with the printer, false otherwise. When this property is set to 'false' the status of the modeler will be changed to 'offline' until 'connected' is set back to 'true'. This will even take precedence over error states. This property is normally used by API managed modelers Default: True |
current_build | URI |
The current build the modeler is processing Required |
description | string |
A short description about this modeler Default: None |
error | string |
Detailed error status on the modeler, if any. Required |
history_collection_frequency | string |
The frequency of collecting the modeler's historic jobs Required Choices
'"daily|monthly|never"'
|
ip_address | string |
The local ip address of the modeler, as a string. Supports both IPv4 and IPv6 Default: None |
latest_upload | iso-8601 datetime |
The last date and time a capture was uploaded for this modeler Required |
name | string |
The name of the modeler Required |
password | string |
The password for corresponding username to communicate with certain machines. It's only used for EOSConnect modeler. Default: None |
serial_number | string |
The serial number of the modeler, as a string Default: None |
status | string |
The status of the modeler, or what it's doing. This cannot be directly changed Required Choices
'"not_connected|error|idle|offline|printing|maintenance|print_finished|ready_to_print|unknown"'
|
type | URI |
The URI to the modeler type of this modeler Required |
updated | iso-8601 datetime |
none available Required |
uri | URI |
The URI to the modeler Required |
username | string |
Special username required to communicate with certain machines. It's only used for EOSConnect modeler. Default: None |
watermark | string |
Marks the reference to the latest historic build collected Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
This means the IP address you entered is invalid. Make sure your ip address is a valid IPv4 or IPv6 address. |
404 |
|
/modeler/{uuid}/
Create and update modelers, and get information about them
Get a modeler by URI
Schema (application/json)
Property | Type | Description |
---|---|---|
cassettes | array |
none available Example: '["..."]'
|
connected | boolean |
True if we are able to communicate with the printer, false otherwise. When this property is set to 'false' the status of the modeler will be changed to 'offline' until 'connected' is set back to 'true'. This will even take precedence over error states. This property is normally used by API managed modelers |
current_build | URI |
The current build the modeler is processing |
description | string |
A short description about this modeler |
error | string |
Detailed error status on the modeler, if any. |
history_collection_frequency | string |
The frequency of collecting the modeler's historic jobs Choices
'"daily|monthly|never"'
|
ip_address | string |
The local ip address of the modeler, as a string. Supports both IPv4 and IPv6 |
latest_upload | iso-8601 datetime |
The last date and time a capture was uploaded for this modeler |
name | string |
The name of the modeler |
password | string |
The password for corresponding username to communicate with certain machines. It's only used for EOSConnect modeler. |
serial_number | string |
The serial number of the modeler, as a string |
status | string |
The status of the modeler, or what it's doing. This cannot be directly changed Choices
'"not_connected|error|idle|offline|printing|maintenance|print_finished|ready_to_print|unknown"'
|
type | URI |
The URI to the modeler type of this modeler |
updated | iso-8601 datetime |
none available |
uri | URI |
The URI to the modeler |
username | string |
Special username required to communicate with certain machines. It's only used for EOSConnect modeler. |
watermark | string |
Marks the reference to the latest historic build collected |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
This means the IP address you entered is invalid. Make sure your ip address is a valid IPv4 or IPv6 address. |
404 |
|
/msnav-import/file-to-order/
This endpoint is for uploading / downloaing Microsoft Nav (MSNav) files. MSNav files are CSV files that we can store, and conver into workstations, and/or convert into Workflows and/or convert into individual Line-Items in an order
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the msnav workflow belongs to |
error | string |
If conversion encountered an error, this will contain error message and correction notes on the error |
msnav_file | URI |
Link to a MS Nav file to turn into an authentise flows order with line-item, etc. |
status | string |
Status of creating an order / line-item msnav-file. Choices
'"pending|making-line-item|making-order|complete|error"'
|
uri | URI |
URI to self, mostly for LIST function |
workflow | URI |
Link to a the nautilus workflow. we created from this. Nullable if still processing, or an error happend |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the msnav workflow belongs to Required |
error | string |
If conversion encountered an error, this will contain error message and correction notes on the error Required |
msnav_file | URI |
Link to a MS Nav file to turn into an authentise flows order with line-item, etc. Required |
status | string |
Status of creating an order / line-item msnav-file. Required Choices
'"pending|making-line-item|making-order|complete|error"'
|
uri | URI |
URI to self, mostly for LIST function Default: None |
workflow | URI |
Link to a the nautilus workflow. we created from this. Nullable if still processing, or an error happend Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This endpoint is for uploading / downloaing Microsoft Nav (MSNav) files. MSNav files are CSV files that we can store, and conver into workstations, and/or convert into Workflows and/or convert into individual Line-Items in an order
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the msnav workflow belongs to |
error | string |
If conversion encountered an error, this will contain error message and correction notes on the error |
msnav_file | URI |
Link to a MS Nav file to turn into an authentise flows order with line-item, etc. |
status | string |
Status of creating an order / line-item msnav-file. Choices
'"pending|making-line-item|making-order|complete|error"'
|
uri | URI |
URI to self, mostly for LIST function |
workflow | URI |
Link to a the nautilus workflow. we created from this. Nullable if still processing, or an error happend |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/msnav-import/file/
This endpoint is for uploading / downloaing Microsoft Nav (MSNav) files. MSNav files are CSV files that we can store, and conver into workstations, and/or convert into Workflows and/or convert into individual Line-Items in an order
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the msnav file belongs to |
created | iso-8601 datetime |
The date the file was uploaded. |
error | string |
If status is an error, this will contain error message and correction notes on the error |
msnav_id | string |
MSNav ID for this file. Note this is parsed from column M (and/or A) |
msnav_workflows | array |
Msnav workflows linked to this file Example: '["..."]'
|
name | string |
filename of the file you are uploading |
notes | string |
any notes concerning the file upload. |
status | string |
Status of file reading / validation process if status is conversion Choices
'"not-uploaded|uploaded|processing|processed|error"'
|
upload_location | string |
none available |
uri | URI |
URI to self, mostly for LIST function |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
401 |
|
404 |
The requested msnav file cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the msnav file belongs to Required |
created | iso-8601 datetime |
The date the file was uploaded. Required |
error | string |
If status is an error, this will contain error message and correction notes on the error Required |
msnav_id | string |
MSNav ID for this file. Note this is parsed from column M (and/or A) Default: None |
msnav_workflows | array |
Msnav workflows linked to this file Default: None Example: '["..."]'
|
name | string |
filename of the file you are uploading Required |
notes | string |
any notes concerning the file upload. Required |
status | string |
Status of file reading / validation process if status is conversion Required Choices
'"not-uploaded|uploaded|processing|processed|error"'
|
upload_location | string |
none available Default: None |
uri | URI |
URI to self, mostly for LIST function Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
401 |
|
404 |
The requested msnav file cannot be found. |
This endpoint is for uploading / downloaing Microsoft Nav (MSNav) files. MSNav files are CSV files that we can store, and conver into workstations, and/or convert into Workflows and/or convert into individual Line-Items in an order
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the msnav file belongs to |
created | iso-8601 datetime |
The date the file was uploaded. |
error | string |
If status is an error, this will contain error message and correction notes on the error |
msnav_id | string |
MSNav ID for this file. Note this is parsed from column M (and/or A) |
msnav_workflows | array |
Msnav workflows linked to this file Example: '["..."]'
|
name | string |
filename of the file you are uploading |
notes | string |
any notes concerning the file upload. |
status | string |
Status of file reading / validation process if status is conversion Choices
'"not-uploaded|uploaded|processing|processed|error"'
|
upload_location | string |
none available |
uri | URI |
URI to self, mostly for LIST function |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
401 |
|
404 |
The requested msnav file cannot be found. |
Endpoint for Action of converting a 'msnav-workflow' into a complete nautilus workflow with process-step, and work-instructions, etc.
no PUT to this endpoint, POST triggers the conversion, or ends in error.
Schema (application/json)
Property | Type | Description |
---|---|---|
error | string |
If conversion encountered an error, this will contain error message and correction notes on the error |
msnav_workflow | URI |
Link to a MS Nav workflow to turn into an authentise flows workflow. |
status | string |
Status of creating a final flows workflow from an msav-workflow. Choices
'"pending|making_process_steps|making_workflow|linking_work_instructions|complete|error"'
|
uri | URI |
URI to our own action self, mostly for LIST function |
workflow | URI |
Link to a the nautilus workflow. we created from this. Nullable if still processing, or an error happend |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
error | string |
If conversion encountered an error, this will contain error message and correction notes on the error Required |
msnav_workflow | URI |
Link to a MS Nav workflow to turn into an authentise flows workflow. Required |
status | string |
Status of creating a final flows workflow from an msav-workflow. Required Choices
'"pending|making_process_steps|making_workflow|linking_work_instructions|complete|error"'
|
uri | URI |
URI to our own action self, mostly for LIST function Default: None |
workflow | URI |
Link to a the nautilus workflow. we created from this. Nullable if still processing, or an error happend Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
Endpoint for Action of converting a 'msnav-workflow' into a complete nautilus workflow with process-step, and work-instructions, etc.
no PUT to this endpoint, POST triggers the conversion, or ends in error.
Schema (application/json)
Property | Type | Description |
---|---|---|
error | string |
If conversion encountered an error, this will contain error message and correction notes on the error |
msnav_workflow | URI |
Link to a MS Nav workflow to turn into an authentise flows workflow. |
status | string |
Status of creating a final flows workflow from an msav-workflow. Choices
'"pending|making_process_steps|making_workflow|linking_work_instructions|complete|error"'
|
uri | URI |
URI to our own action self, mostly for LIST function |
workflow | URI |
Link to a the nautilus workflow. we created from this. Nullable if still processing, or an error happend |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/msnav-import/workflow/
TODO: add docs
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the msnav workflow belongs to |
msnav_files | array |
Link to any/all MSNAV files using this workflow in our system Example: '["..."]'
|
name | string |
Workflow name. Usually a MSNAV ID |
uri | URI |
URI to self, mostly for LIST function |
workflow | URI |
URI to self, mostly for LIST function |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the msnav workflow belongs to Required |
msnav_files | array |
Link to any/all MSNAV files using this workflow in our system Default: None Example: '["..."]'
|
name | string |
Workflow name. Usually a MSNAV ID Required |
uri | URI |
URI to self, mostly for LIST function Default: None |
workflow | URI |
URI to self, mostly for LIST function Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
TODO: add docs
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the msnav workflow belongs to |
msnav_files | array |
Link to any/all MSNAV files using this workflow in our system Example: '["..."]'
|
name | string |
Workflow name. Usually a MSNAV ID |
uri | URI |
URI to self, mostly for LIST function |
workflow | URI |
URI to self, mostly for LIST function |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/nebumind-analysis/
Endpoint to see the status of a Nebumind analysis.
This represents the states/behaviour of peer service Nebumind processing mpm-format data + Nebumind's analysis page, and then letting Rapidfab embed the Nebumind analysis web page (3D view/statistics).
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the Nebumind Analysis was created (requested). |
currency | string |
The currency of the costs in this endpoint. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
indications | array |
none available Example: '[{}]'
|
nebumind_user_name | string |
Nebumind Analysis user name |
nebumind_user_password | string |
Nebumind Analysis user password |
notes | string |
notes or errors on transaction |
piece | URI |
This nebumind analysis is triggered on the printing step of this piece. |
status | string |
The processing status of this analysis in the Nebumind instance. Choices
'"new|in_progress|complete|error"'
|
updated | iso-8601 datetime |
When the Nebumind Analysis was updated |
uri | URI |
The URI to this record. |
visualization | string |
3d model with all indications overlaid |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the Nebumind Analysis was created (requested). Required |
currency | string |
The currency of the costs in this endpoint. Required Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
indications | array |
none available Required Example: '[{}]'
|
nebumind_user_name | string |
Nebumind Analysis user name Required |
nebumind_user_password | string |
Nebumind Analysis user password Required |
notes | string |
notes or errors on transaction Required |
piece | URI |
This nebumind analysis is triggered on the printing step of this piece. Required |
status | string |
The processing status of this analysis in the Nebumind instance. Required Choices
'"new|in_progress|complete|error"'
|
updated | iso-8601 datetime |
When the Nebumind Analysis was updated Required |
uri | URI |
The URI to this record. Required |
visualization | string |
3d model with all indications overlaid Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
Endpoint to see the status of a Nebumind analysis.
This represents the states/behaviour of peer service Nebumind processing mpm-format data + Nebumind's analysis page, and then letting Rapidfab embed the Nebumind analysis web page (3D view/statistics).
generic get one resource by exact UUID
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the Nebumind Analysis was created (requested). |
currency | string |
The currency of the costs in this endpoint. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
indications | array |
none available Example: '[{}]'
|
nebumind_user_name | string |
Nebumind Analysis user name |
nebumind_user_password | string |
Nebumind Analysis user password |
notes | string |
notes or errors on transaction |
piece | URI |
This nebumind analysis is triggered on the printing step of this piece. |
status | string |
The processing status of this analysis in the Nebumind instance. Choices
'"new|in_progress|complete|error"'
|
updated | iso-8601 datetime |
When the Nebumind Analysis was updated |
uri | URI |
The URI to this record. |
visualization | string |
3d model with all indications overlaid |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
/notifications/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
context | object |
none available Example: 'null'
|
created | iso-8601 datetime |
none available |
emails | array |
none available Example: '["..."]'
|
reply_to | string |
none available |
template | string |
none available Choices
'"customer.support_request|nautilus.bureau_bid_declined_email|nautilus.bureau_bid_updated_email|nautilus.bureau_inactivate_process_provider|nautilus.model_upload_failed|nautilus.order_complete|nautilus.order_created|nautilus.order_line_items_confirmed|nautilus.order_owner|nautilus.order_scheduled|nautilus.order_shipped|nautilus.order_start_printing|nautilus.order_summary|nautilus.order_summary_ephemeral_user|nautilus.order_update|nautilus.print_error|nautilus.process_provider_activated|nautilus.process_provider_declined|nautilus.process_provider_invited|nautilus.service_provider_canceled_email|nautilus.service_provider_confirmation_email|nautilus.service_provider_inactivate_process_provider|nautilus.service_provider_order_request_email|nautilus.service_provider_registration|nautilus.service_provider_update_email|nautilus.stock_available_below_min_quantity|nautilus.user_mentioned_in_comment|nautilus.work_instruction_piece_owner|users.blocked_for_login|users.guest_registered|users.password_reset|users.welcome_mailer|vision.alert"'
|
uri | URI |
none available |
user | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
context | object |
none available Required Example: 'null'
|
created | iso-8601 datetime |
none available Default: None |
emails | array |
none available Default: None Example: '["..."]'
|
reply_to | string |
none available Default: None |
template | string |
none available Required Choices
'"customer.support_request|nautilus.bureau_bid_declined_email|nautilus.bureau_bid_updated_email|nautilus.bureau_inactivate_process_provider|nautilus.model_upload_failed|nautilus.order_complete|nautilus.order_created|nautilus.order_line_items_confirmed|nautilus.order_owner|nautilus.order_scheduled|nautilus.order_shipped|nautilus.order_start_printing|nautilus.order_summary|nautilus.order_summary_ephemeral_user|nautilus.order_update|nautilus.print_error|nautilus.process_provider_activated|nautilus.process_provider_declined|nautilus.process_provider_invited|nautilus.service_provider_canceled_email|nautilus.service_provider_confirmation_email|nautilus.service_provider_inactivate_process_provider|nautilus.service_provider_order_request_email|nautilus.service_provider_registration|nautilus.service_provider_update_email|nautilus.stock_available_below_min_quantity|nautilus.user_mentioned_in_comment|nautilus.work_instruction_piece_owner|users.blocked_for_login|users.guest_registered|users.password_reset|users.welcome_mailer|vision.alert"'
|
uri | URI |
none available Default: None |
user | URI |
none available Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
context | object |
none available Example: 'null'
|
created | iso-8601 datetime |
none available |
emails | array |
none available Example: '["..."]'
|
reply_to | string |
none available |
template | string |
none available Choices
'"customer.support_request|nautilus.bureau_bid_declined_email|nautilus.bureau_bid_updated_email|nautilus.bureau_inactivate_process_provider|nautilus.model_upload_failed|nautilus.order_complete|nautilus.order_created|nautilus.order_line_items_confirmed|nautilus.order_owner|nautilus.order_scheduled|nautilus.order_shipped|nautilus.order_start_printing|nautilus.order_summary|nautilus.order_summary_ephemeral_user|nautilus.order_update|nautilus.print_error|nautilus.process_provider_activated|nautilus.process_provider_declined|nautilus.process_provider_invited|nautilus.service_provider_canceled_email|nautilus.service_provider_confirmation_email|nautilus.service_provider_inactivate_process_provider|nautilus.service_provider_order_request_email|nautilus.service_provider_registration|nautilus.service_provider_update_email|nautilus.stock_available_below_min_quantity|nautilus.user_mentioned_in_comment|nautilus.work_instruction_piece_owner|users.blocked_for_login|users.guest_registered|users.password_reset|users.welcome_mailer|vision.alert"'
|
uri | URI |
none available |
user | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
As part of oAuth standard, this does ???
this is called by ? @param provider is a string that matches a known oAuth provider name
Schema (application/json)
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/oauth/callback/
This is called by our Identity Provider to let us know that the identity provder is processing a request to ?
This seeems to get called by oAuth ID provider to ?? our ??, to return ? :return: A redirect (if given as a URL param) or a NO_CONTENT reply
Schema (application/json)
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
500 |
|
This is called by ? to get from nautilus the access token to a Partner aPI
to get an Access Token to a partner API, we may need to transact to oAuth ID server?
Schema (application/json)
Property | Type | Description |
---|---|---|
access_token | string |
The value of the access token right now |
expires | iso-8601 datetime |
The date and time in UTC when this token expires |
provider | string |
The name of the provider the token is for Choices
'"autodesk-forge|zverse|castor3d|pathfindr"'
|
user | URI |
The user the token is for |
uuid | uuid |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/order-packing-slip/
An OrderPackingSlip
is a docx file listing what needs to be shipped in an order.
It may include all or some limited group of Line Items in the Order it is related to.
Packing slip may need to be regenerated at a new date.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. |
content | URL |
the download link for the packing slip document. |
created | iso-8601 datetime |
The date the packing slip was created. |
order | URI |
The order to get an packing slip document on. |
status | string |
none available Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the packing slip. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested packing slip cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. Required |
content | URL |
the download link for the packing slip document. Required |
created | iso-8601 datetime |
The date the packing slip was created. Required |
order | URI |
The order to get an packing slip document on. Required |
status | string |
none available Required Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the packing slip. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested packing slip cannot be found. |
An OrderPackingSlip
is a docx file listing what needs to be shipped in an order.
It may include all or some limited group of Line Items in the Order it is related to.
Packing slip may need to be regenerated at a new date.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. |
content | URL |
the download link for the packing slip document. |
created | iso-8601 datetime |
The date the packing slip was created. |
order | URI |
The order to get an packing slip document on. |
status | string |
none available Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the packing slip. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested packing slip cannot be found. |
Order part quote callback.
Order part quote callback
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | string |
none available Required |
callback_method | string |
none available Required |
callback_url | URL |
none available Required |
currency | string |
none available Required |
material | string |
none available Required |
model | string |
none available Required |
price | float |
none available Required |
status | string |
none available Required |
uri | URL |
none available Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested order part cannot be found. |
/order-part/
A Streamics order part record.
List all of the order part in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
attachments_ids | array |
none available Example: '["..."]'
|
build_due_date | iso-8601 datetime |
none available |
check_out_date | iso-8601 datetime |
none available |
check_out_to | string |
none available |
comments | array |
none available Example: '["..."]'
|
counters | object |
none available Example: 'null'
|
created_by | string |
none available |
created_date | iso-8601 datetime |
none available |
custom_fields | object |
none available Example: 'null'
|
due_date | iso-8601 datetime |
none available |
external_id | string |
none available |
file_id | integer |
none available |
file_name | string |
none available |
id | integer |
none available |
material_external_id | string |
none available |
model_uri | URL |
The URI of the order part's model. |
modified_by | string |
none available |
modified_date | iso-8601 datetime |
none available |
needs_validation | boolean |
none available |
order | URI |
The URI of the order this order part belongs to. |
order_external_id | string |
none available |
parameters | object |
none available Example: 'null'
|
part_id | integer |
none available |
part_name | string |
none available |
planned_end_date | iso-8601 datetime |
none available |
post_processing_estimation | float |
none available |
post_processing_template | integer |
none available |
price | float |
none available |
quantity | integer |
none available |
quoted_part_external_id | string |
none available |
quotes | array |
none available Example: '["..."]'
|
status | string |
none available |
uri | URI |
The URI of the order part. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested order part cannot be found. |
Create a new order part.
Schema (application/json)
Property | Type | Description |
---|---|---|
attachments_ids | array |
none available Default: [] Example: '["..."]'
|
build_due_date | iso-8601 datetime |
none available Default: None |
check_out_date | iso-8601 datetime |
none available Default: None |
check_out_to | string |
none available Default: None |
comments | array |
none available Default: [] Example: '["..."]'
|
counters | object |
none available Default: {} Example: 'null'
|
created_by | string |
none available Required |
created_date | iso-8601 datetime |
none available Required |
custom_fields | object |
none available Required Example: 'null'
|
due_date | iso-8601 datetime |
none available Required |
external_id | string |
none available Required |
file_id | integer |
none available Required |
file_name | string |
none available Required |
id | integer |
none available Required |
material_external_id | string |
none available Required |
model_uri | URL |
The URI of the order part's model. Required |
modified_by | string |
none available Required |
modified_date | iso-8601 datetime |
none available Required |
needs_validation | boolean |
none available Default: None |
order | URI |
The URI of the order this order part belongs to. Default: None |
order_external_id | string |
none available Required |
parameters | object |
none available Default: {} Example: 'null'
|
part_id | integer |
none available Required |
part_name | string |
none available Required |
planned_end_date | iso-8601 datetime |
none available Required |
post_processing_estimation | float |
none available Default: None |
post_processing_template | integer |
none available Default: None |
price | float |
none available Default: None |
quantity | integer |
none available Required |
quoted_part_external_id | string |
none available Default: None |
quotes | array |
none available Default: None Example: '["..."]'
|
status | string |
none available Required |
uri | URI |
The URI of the order part. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested order part cannot be found. |
A Streamics order part record.
Get a single order part by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
attachments_ids | array |
none available Example: '["..."]'
|
build_due_date | iso-8601 datetime |
none available |
check_out_date | iso-8601 datetime |
none available |
check_out_to | string |
none available |
comments | array |
none available Example: '["..."]'
|
counters | object |
none available Example: 'null'
|
created_by | string |
none available |
created_date | iso-8601 datetime |
none available |
custom_fields | object |
none available Example: 'null'
|
due_date | iso-8601 datetime |
none available |
external_id | string |
none available |
file_id | integer |
none available |
file_name | string |
none available |
id | integer |
none available |
material_external_id | string |
none available |
model_uri | URL |
The URI of the order part's model. |
modified_by | string |
none available |
modified_date | iso-8601 datetime |
none available |
needs_validation | boolean |
none available |
order | URI |
The URI of the order this order part belongs to. |
order_external_id | string |
none available |
parameters | object |
none available Example: 'null'
|
part_id | integer |
none available |
part_name | string |
none available |
planned_end_date | iso-8601 datetime |
none available |
post_processing_estimation | float |
none available |
post_processing_template | integer |
none available |
price | float |
none available |
quantity | integer |
none available |
quoted_part_external_id | string |
none available |
quotes | array |
none available Example: '["..."]'
|
status | string |
none available |
uri | URI |
The URI of the order part. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested order part cannot be found. |
/order-quote/
An ‘Order Quote’ is an outbound Quote (price to end customer) for a bureau customers send to their customers for an order. This is for all line-items in an order, see LineItemQuote for detailed data for each line-item in the order.
There may be multiple revisions of an in an ’Order Quote' for a single Order object. Usually you only want to use the newest (or the highest # version) of the OrderQuote.
When agreed to by the customer, the parent 'order.quote_approved' value is set to True. FOOTNOTE[1]
Old version may represent different versions or updates or state-changes in that orders history.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. |
content | URL |
the download link for the document |
created | iso-8601 datetime |
The date the report was created. |
order | URI |
The order to get a quote document on. |
status | string |
Status of a report. Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the order quote. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested report cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. Required |
content | URL |
the download link for the document Default: None |
created | iso-8601 datetime |
The date the report was created. Default: None |
order | URI |
The order to get a quote document on. Required |
status | string |
Status of a report. Default: None Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the order quote. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested report cannot be found. |
An ‘Order Quote’ is an outbound Quote (price to end customer) for a bureau customers send to their customers for an order. This is for all line-items in an order, see LineItemQuote for detailed data for each line-item in the order.
There may be multiple revisions of an in an ’Order Quote' for a single Order object. Usually you only want to use the newest (or the highest # version) of the OrderQuote.
When agreed to by the customer, the parent 'order.quote_approved' value is set to True. FOOTNOTE[1]
Old version may represent different versions or updates or state-changes in that orders history.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. |
content | URL |
the download link for the document |
created | iso-8601 datetime |
The date the report was created. |
order | URI |
The order to get a quote document on. |
status | string |
Status of a report. Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the order quote. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested report cannot be found. |
/order-report/
The order-report api is for exporting the details of an Order along with the line-items associated with it as a printable csv.
Schema (application/json)
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/order-streamics/
This is our backend end for connection to our Streamics bridge.
The streamics bridge is in it's own repository, StreamicsConnector.
Some customers can use Stremics as a third party is where an order can be placed/
List all of the order in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
attachments_ids | array |
none available Example: '["..."]'
|
build_due_date | iso-8601 datetime |
none available |
comments | array |
none available Example: '["..."]'
|
contact_person_external_id | string |
none available |
created_by | string |
none available |
created_date | iso-8601 datetime |
none available |
custom_fields | object |
none available Example: 'null'
|
due_date | iso-8601 datetime |
none available |
external_id | string |
none available |
id | integer |
none available |
modified_by | string |
none available |
modified_date | iso-8601 datetime |
none available |
ordered_parts_total_quantity | integer |
none available |
planned_end_date | iso-8601 datetime |
none available |
price | float |
none available |
quote_external_id | string |
none available |
status | string |
none available |
uri | URI |
The URI of the order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested order cannot be found. |
Create a new order.
Schema (application/json)
Property | Type | Description |
---|---|---|
attachments_ids | array |
none available Required Example: '["..."]'
|
build_due_date | iso-8601 datetime |
none available Default: None |
comments | array |
none available Default: [] Example: '["..."]'
|
contact_person_external_id | string |
none available Required |
created_by | string |
none available Required |
created_date | iso-8601 datetime |
none available Required |
custom_fields | object |
none available Default: {} Example: 'null'
|
due_date | iso-8601 datetime |
none available Required |
external_id | string |
none available Required |
id | integer |
none available Required |
modified_by | string |
none available Required |
modified_date | iso-8601 datetime |
none available Required |
ordered_parts_total_quantity | integer |
none available Required |
planned_end_date | iso-8601 datetime |
none available Required |
price | float |
none available Default: None |
quote_external_id | string |
none available Default: None |
status | string |
none available Required |
uri | URI |
The URI of the order. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested order cannot be found. |
This is our backend end for connection to our Streamics bridge.
The streamics bridge is in it's own repository, StreamicsConnector.
Some customers can use Stremics as a third party is where an order can be placed/
Get a single order by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
attachments_ids | array |
none available Example: '["..."]'
|
build_due_date | iso-8601 datetime |
none available |
comments | array |
none available Example: '["..."]'
|
contact_person_external_id | string |
none available |
created_by | string |
none available |
created_date | iso-8601 datetime |
none available |
custom_fields | object |
none available Example: 'null'
|
due_date | iso-8601 datetime |
none available |
external_id | string |
none available |
id | integer |
none available |
modified_by | string |
none available |
modified_date | iso-8601 datetime |
none available |
ordered_parts_total_quantity | integer |
none available |
planned_end_date | iso-8601 datetime |
none available |
price | float |
none available |
quote_external_id | string |
none available |
status | string |
none available |
uri | URI |
The URI of the order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested order cannot be found. |
/order/
An order is how a user tells the system they would like a particular bureau to build a particular part or parts.
The order is mostly composed of line-item
resources which should be created before creating the order. Each
line item contains information on a particular model in a particular quantity to produce. The order then aggregates
the line-items with metadata about the currency to quote the order in, total estimates of cost and time, shipping
information to use to send the parts to the customer and overall status of the order.
The status of an order is normally calculated as the aggregate status of the line-items of the order. When an order has all line items printing, the status is printing. When all line items are complete, the order is complete.
Orders should normally be specified with the bureau, line_items, name and shipping. Other fields are populated as the order moves through the system towards completion
List all of the order in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
application_type | string |
Application type, field specific to business-segment bureaus. Choices
'"prototype|tooling|end_component"'
|
build_file_status | string |
none available Choices
'"Pending|In Progress|Complete"'
|
bureau | URI |
The URI of the bureau. |
callback_method | string |
Callback method |
callback_url | string |
Callback URL |
country | string |
3 digit ISO 3166 country code for non danfoss bureau |
created | iso-8601 datetime |
The date the order was created. |
created_by | string |
Name of user that created order |
custom_field_values | array |
none available Example: '[{}]'
|
customer_email |
Customer email address. |
|
customer_go | string |
none available Choices
'"Yes|No"'
|
customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID-8 |
customer_name | string |
Customer name for the order. |
customer_po | string |
Customer PO which is a reference to Customer number. |
due_date | iso-8601 datetime |
The due date for the order. |
error | string |
none available |
estimates | object |
none available Example: '{"cost": {}, "materials": {}}'
|
external_id | string |
External ID for an order. |
ip_sensitivity | string |
The intellectual property sensitivity. |
line_items | array |
The uri of the line items inside this order. Example: '["..."]'
|
location | URI |
URI of the location |
locations_available | array |
list of manufacturing locations available for this order Example: '["..."]'
|
name | string |
Name of the order. |
notes | string |
System notes if the system auto-updates values, or is reporting a warning. |
order_owner | URI |
The URI of the order owner. |
order_owner_name | string |
The name of the order.order_owner user. |
order_type | string |
Order type choices. Choice depends on the bureau. Choices
'"benchmark|commercial|r-d|sample-free|timestudy"'
|
planning_status | string |
none available Choices
'"Pending|In Progress|Complete"'
|
priority | integer |
0 to 100 value of priority, higher means 'runs sooner' |
quote_approved | boolean |
Date and time when certain revision of order quote was approved. |
quote_discount_type | string |
Discount type for quote. Choices
'"percentage|amount"'
|
quote_discount_value | float |
Discount that should be applied for total cost in quote. |
quote_markup_value | float |
Markup percentage to apply to all line-items in this order Example: '"50.35"'
|
quote_notes | string |
Notes for the order quote. |
quote_number | string |
A reference to Sales quotes |
quote_required | boolean |
Whether order quote workflow required or not. |
region | string |
Region of the order. |
run_status | string |
By transferred run status returning orders where at least one run has that status Choices
'"calculating|calculated|queued|in-progress|paused|complete|error|cancelled"'
|
shipping | object |
none available Example: '{}'
|
shipping_grouping | string |
Order shipping grouping strategy: 'by_batching_strategy' means use default logic for planning shipping, 'by_order' means put all pieces in the order to a same single shipping run. Choices
'"by_batching_strategy|by_order"'
|
special_processing_required | boolean |
Whether re-design hours or special post-processing required or not. |
status | string |
Status of an order. Choices
'"calculating_estimates|cancelled|confirmed|complete|error|new|pending|in-preparation|processing|post-processing|printing|shipping|cloning"'
|
updated | iso-8601 datetime |
The date the order was updated. |
uri | URI |
The URI of the order. |
used_material_families | array |
By transferred list of material family(s) returning orders where at least one line_item using material (base/support) with any of the material family(s). Example: '["Priority|Polymer|Composite|Metal|Ceramic|Wax|Sand"]'
|
user | URI |
The URI of the user who created the order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The model does not seem printable An order with prints associated with a run cannot be deleted Provided status transformation is not allowed You cannot delete order which is already confirmed (this is not allowed for restricted and guest users). Order quote can't be generated if order confirmed. Or, cannot be approved if there is no customer_po specified.
|
404 |
The requested order cannot be found. |
Create a new order.
Schema (application/json)
Property | Type | Description |
---|---|---|
application_type | string |
Application type, field specific to business-segment bureaus. Default: None Choices
'"prototype|tooling|end_component"'
|
build_file_status | string |
none available Required Choices
'"Pending|In Progress|Complete"'
|
bureau | URI |
The URI of the bureau. Required |
callback_method | string |
Callback method Default: None |
callback_url | string |
Callback URL Default: None |
country | string |
3 digit ISO 3166 country code for non danfoss bureau Default: None |
created | iso-8601 datetime |
The date the order was created. Default: None |
created_by | string |
Name of user that created order Default: None |
custom_field_values | array |
none available Default: None Example: '[{}]'
|
customer_email |
Customer email address. Default: None |
|
customer_go | string |
none available Required Choices
'"Yes|No"'
|
customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID-8 Required |
customer_name | string |
Customer name for the order. Default: None |
customer_po | string |
Customer PO which is a reference to Customer number. Default: None |
due_date | iso-8601 datetime |
The due date for the order. Default: None |
error | string |
none available Default: None |
estimates | object |
none available Required Example: '{"cost": {}, "materials": {}}'
|
external_id | string |
External ID for an order. Default: None |
ip_sensitivity | string |
The intellectual property sensitivity. Default: None |
line_items | array |
The uri of the line items inside this order. Required Example: '["..."]'
|
location | URI |
URI of the location Default: None |
locations_available | array |
list of manufacturing locations available for this order Default: [] Example: '["..."]'
|
name | string |
Name of the order. Required |
notes | string |
System notes if the system auto-updates values, or is reporting a warning. Required |
order_owner | URI |
The URI of the order owner. Default: None |
order_owner_name | string |
The name of the order.order_owner user. Required |
order_type | string |
Order type choices. Choice depends on the bureau. Default: None Choices
'"benchmark|commercial|r-d|sample-free|timestudy"'
|
planning_status | string |
none available Required Choices
'"Pending|In Progress|Complete"'
|
priority | integer |
0 to 100 value of priority, higher means 'runs sooner' Default: 65 |
quote_approved | boolean |
Date and time when certain revision of order quote was approved. Default: False |
quote_discount_type | string |
Discount type for quote. Default: amount Choices
'"percentage|amount"'
|
quote_discount_value | float |
Discount that should be applied for total cost in quote. Default: None |
quote_markup_value | float |
Markup percentage to apply to all line-items in this order Default: 0 Example: '"50.35"'
|
quote_notes | string |
Notes for the order quote. Default: None |
quote_number | string |
A reference to Sales quotes Default: None |
quote_required | boolean |
Whether order quote workflow required or not. Default: False |
region | string |
Region of the order. Default: None |
run_status | string |
By transferred run status returning orders where at least one run has that status Required Choices
'"calculating|calculated|queued|in-progress|paused|complete|error|cancelled"'
|
shipping | object |
none available Required Example: '{}'
|
shipping_grouping | string |
Order shipping grouping strategy: 'by_batching_strategy' means use default logic for planning shipping, 'by_order' means put all pieces in the order to a same single shipping run. Default: by_batching_strategy Choices
'"by_batching_strategy|by_order"'
|
special_processing_required | boolean |
Whether re-design hours or special post-processing required or not. Default: False |
status | string |
Status of an order. Default: None Choices
'"calculating_estimates|cancelled|confirmed|complete|error|new|pending|in-preparation|processing|post-processing|printing|shipping|cloning"'
|
updated | iso-8601 datetime |
The date the order was updated. Required |
uri | URI |
The URI of the order. Default: None |
used_material_families | array |
By transferred list of material family(s) returning orders where at least one line_item using material (base/support) with any of the material family(s). Required Example: '["Priority|Polymer|Composite|Metal|Ceramic|Wax|Sand"]'
|
user | URI |
The URI of the user who created the order. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The model does not seem printable An order with prints associated with a run cannot be deleted Provided status transformation is not allowed You cannot delete order which is already confirmed (this is not allowed for restricted and guest users). Order quote can't be generated if order confirmed. Or, cannot be approved if there is no customer_po specified.
|
404 |
The requested order cannot be found. |
/order//clone/
Based on received in URL order_uuid
(target order) copying an Order
and run background task nautilus.backend.order.promise_copy_products
for copying
related valid Products and their Line Items.
Schema (application/json)
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested order cannot be found. |
/order/{uuid}/
An order is how a user tells the system they would like a particular bureau to build a particular part or parts.
The order is mostly composed of line-item
resources which should be created before creating the order. Each
line item contains information on a particular model in a particular quantity to produce. The order then aggregates
the line-items with metadata about the currency to quote the order in, total estimates of cost and time, shipping
information to use to send the parts to the customer and overall status of the order.
The status of an order is normally calculated as the aggregate status of the line-items of the order. When an order has all line items printing, the status is printing. When all line items are complete, the order is complete.
Orders should normally be specified with the bureau, line_items, name and shipping. Other fields are populated as the order moves through the system towards completion
Get a single order by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
application_type | string |
Application type, field specific to business-segment bureaus. Choices
'"prototype|tooling|end_component"'
|
build_file_status | string |
none available Choices
'"Pending|In Progress|Complete"'
|
bureau | URI |
The URI of the bureau. |
callback_method | string |
Callback method |
callback_url | string |
Callback URL |
country | string |
3 digit ISO 3166 country code for non danfoss bureau |
created | iso-8601 datetime |
The date the order was created. |
created_by | string |
Name of user that created order |
custom_field_values | array |
none available Example: '[{}]'
|
customer_email |
Customer email address. |
|
customer_go | string |
none available Choices
'"Yes|No"'
|
customer_id | string |
Human readable alpha-numeric, customer defined ID. Defaults to UUID-8 |
customer_name | string |
Customer name for the order. |
customer_po | string |
Customer PO which is a reference to Customer number. |
due_date | iso-8601 datetime |
The due date for the order. |
error | string |
none available |
estimates | object |
none available Example: '{"cost": {}, "materials": {}}'
|
external_id | string |
External ID for an order. |
ip_sensitivity | string |
The intellectual property sensitivity. |
line_items | array |
The uri of the line items inside this order. Example: '["..."]'
|
location | URI |
URI of the location |
locations_available | array |
list of manufacturing locations available for this order Example: '["..."]'
|
name | string |
Name of the order. |
notes | string |
System notes if the system auto-updates values, or is reporting a warning. |
order_owner | URI |
The URI of the order owner. |
order_owner_name | string |
The name of the order.order_owner user. |
order_type | string |
Order type choices. Choice depends on the bureau. Choices
'"benchmark|commercial|r-d|sample-free|timestudy"'
|
planning_status | string |
none available Choices
'"Pending|In Progress|Complete"'
|
priority | integer |
0 to 100 value of priority, higher means 'runs sooner' |
quote_approved | boolean |
Date and time when certain revision of order quote was approved. |
quote_discount_type | string |
Discount type for quote. Choices
'"percentage|amount"'
|
quote_discount_value | float |
Discount that should be applied for total cost in quote. |
quote_markup_value | float |
Markup percentage to apply to all line-items in this order Example: '"50.35"'
|
quote_notes | string |
Notes for the order quote. |
quote_number | string |
A reference to Sales quotes |
quote_required | boolean |
Whether order quote workflow required or not. |
region | string |
Region of the order. |
run_status | string |
By transferred run status returning orders where at least one run has that status Choices
'"calculating|calculated|queued|in-progress|paused|complete|error|cancelled"'
|
shipping | object |
none available Example: '{}'
|
shipping_grouping | string |
Order shipping grouping strategy: 'by_batching_strategy' means use default logic for planning shipping, 'by_order' means put all pieces in the order to a same single shipping run. Choices
'"by_batching_strategy|by_order"'
|
special_processing_required | boolean |
Whether re-design hours or special post-processing required or not. |
status | string |
Status of an order. Choices
'"calculating_estimates|cancelled|confirmed|complete|error|new|pending|in-preparation|processing|post-processing|printing|shipping|cloning"'
|
updated | iso-8601 datetime |
The date the order was updated. |
uri | URI |
The URI of the order. |
used_material_families | array |
By transferred list of material family(s) returning orders where at least one line_item using material (base/support) with any of the material family(s). Example: '["Priority|Polymer|Composite|Metal|Ceramic|Wax|Sand"]'
|
user | URI |
The URI of the user who created the order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The model does not seem printable An order with prints associated with a run cannot be deleted Provided status transformation is not allowed You cannot delete order which is already confirmed (this is not allowed for restricted and guest users). Order quote can't be generated if order confirmed. Or, cannot be approved if there is no customer_po specified.
|
404 |
The requested order cannot be found. |
/part/{uuid}/
Get information about parts. This is just a placeholder and not yet implemented
Schema (application/json)
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
/payment/
This endpoint is to link a payment to another resource. Enables users to make purchasers manually and in the future automatically
through stripe or other third party payment processors. For now, we are only accepting payments for an order
created via DDW
shopping-cart checkout process. This functionality might be expanded in the future.
For restricted buyer this will List all of the payments in the system for their account. For normal internal bureau user
this will display all payment records for that bureau. Use payment['purchaser']
for the 'owning' user,
who is doing the purchasing.
Schema (application/json)
Property | Type | Description |
---|---|---|
checkout_url | URL |
For stripe integration a checkout url is dynamically generated. This url will be used to redirect front-end user to stripe hosted page. Future this might expand to other providers. |
fees | array |
none available Example: '[{}]'
|
payment_for | URI |
What the payment is for. For v1 we will only need be accepting payments for orders. Might be expanded in the future. |
payment_system | string |
The URI of piece's line item. Choices
'"manual|stripe"'
|
purchaser | URI |
The purchaser(user) that is making a payment for the order or whatever payment_for is. |
status | string |
Step position of a print which currently in-progress or queued as a next, or, if all prints completed, last print.process_step_position; or first, if piece manufacturing not scheduled yet. Choices
'"new|ready|pending|complete|abandoned|error"'
|
sub_total | float |
The price paid by the user. For v1, this price is in exchange for the order identified by payment_for. |
uri | URI |
URI for the payment. Payment is a record of a customer payment for some resource. Currently only linked to order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Invalid payload.
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
checkout_url | URL |
For stripe integration a checkout url is dynamically generated. This url will be used to redirect front-end user to stripe hosted page. Future this might expand to other providers. Required |
fees | array |
none available Required Example: '[{}]'
|
payment_for | URI |
What the payment is for. For v1 we will only need be accepting payments for orders. Might be expanded in the future. Required |
payment_system | string |
The URI of piece's line item. Required Choices
'"manual|stripe"'
|
purchaser | URI |
The purchaser(user) that is making a payment for the order or whatever payment_for is. Required |
status | string |
Step position of a print which currently in-progress or queued as a next, or, if all prints completed, last print.process_step_position; or first, if piece manufacturing not scheduled yet. Required Choices
'"new|ready|pending|complete|abandoned|error"'
|
sub_total | float |
The price paid by the user. For v1, this price is in exchange for the order identified by payment_for. Required |
uri | URI |
URI for the payment. Payment is a record of a customer payment for some resource. Currently only linked to order. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Invalid payload.
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
/payment/{uuid}/
This endpoint is to link a payment to another resource. Enables users to make purchasers manually and in the future automatically
through stripe or other third party payment processors. For now, we are only accepting payments for an order
created via DDW
shopping-cart checkout process. This functionality might be expanded in the future.
Schema (application/json)
Property | Type | Description |
---|---|---|
checkout_url | URL |
For stripe integration a checkout url is dynamically generated. This url will be used to redirect front-end user to stripe hosted page. Future this might expand to other providers. |
fees | array |
none available Example: '[{}]'
|
payment_for | URI |
What the payment is for. For v1 we will only need be accepting payments for orders. Might be expanded in the future. |
payment_system | string |
The URI of piece's line item. Choices
'"manual|stripe"'
|
purchaser | URI |
The purchaser(user) that is making a payment for the order or whatever payment_for is. |
status | string |
Step position of a print which currently in-progress or queued as a next, or, if all prints completed, last print.process_step_position; or first, if piece manufacturing not scheduled yet. Choices
'"new|ready|pending|complete|abandoned|error"'
|
sub_total | float |
The price paid by the user. For v1, this price is in exchange for the order identified by payment_for. |
uri | URI |
URI for the payment. Payment is a record of a customer payment for some resource. Currently only linked to order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Invalid payload.
|
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
/permission-bureau/
A permision bureau record represenst a right that is created for a user on the bureau. This right such as material.all will allow the user to edit, update, and delete the associated record type. In this case it is material. Creating a record here will grant the user access to perform the associated actions. Deleting will revoke the permission.
List all of the bureau permissions in the system.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. |
right | string |
Right for the permission. Choices
'"currency_conversion.all|location.all|manufacturer.all|material.all|model_library.all|bureau.permission.all|post_processor_type.all|printer_type.all|service_provider.all|shipping.all|specimen.all|workflow.all"'
|
uri | URI |
The URI of the bureau. |
user | string |
User associated to the permission. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested permission is not found. |
Create a new bureau permission.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. Required |
right | string |
Right for the permission. Required Choices
'"currency_conversion.all|location.all|manufacturer.all|material.all|model_library.all|bureau.permission.all|post_processor_type.all|printer_type.all|service_provider.all|shipping.all|specimen.all|workflow.all"'
|
uri | URI |
The URI of the bureau. Default: None |
user | string |
User associated to the permission. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested permission is not found. |
A permision bureau record represenst a right that is created for a user on the bureau. This right such as material.all will allow the user to edit, update, and delete the associated record type. In this case it is material. Creating a record here will grant the user access to perform the associated actions. Deleting will revoke the permission.
Get a single bureau permission.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of the bureau. |
right | string |
Right for the permission. Choices
'"currency_conversion.all|location.all|manufacturer.all|material.all|model_library.all|bureau.permission.all|post_processor_type.all|printer_type.all|service_provider.all|shipping.all|specimen.all|workflow.all"'
|
uri | URI |
The URI of the bureau. |
user | string |
User associated to the permission. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested permission is not found. |
/permissions/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
created_by | URI |
none available |
holder | string |
none available |
namespace | string |
none available |
object | string |
none available |
resource_name | string |
none available |
resource_uuid | uuid |
none available |
right | string |
none available |
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
created_by | URI |
none available Default: None |
holder | string |
none available Default: * |
namespace | string |
none available Required |
object | string |
none available Required |
resource_name | string |
none available Default: None |
resource_uuid | uuid |
none available Default: None |
right | string |
none available Required |
uri | URI |
none available Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
created_by | URI |
none available |
holder | string |
none available |
namespace | string |
none available |
object | string |
none available |
resource_name | string |
none available |
resource_uuid | uuid |
none available |
right | string |
none available |
uri | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
/piece-actuals/
This contains the log of what has actually happened for a piece.
There is no API to create/edit resource, resources are created automatically when print actuals is created. Print Actuals are created from RunActuals, when run goes into in-progress state.
List all piece actuals.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When piece actuals record was created |
end_in_progress_time | iso-8601 datetime |
When piece was completed (last print of this piece is completed).Can be null if not completed yet or time can't be recognized. |
per_step_details | array |
List of process steps of this piece. Example: '[{}]'
|
piece | URI |
The URI of the related piece |
start_in_progress_time | iso-8601 datetime |
When piece was started (status of first print was changed to in progress). |
total_cost | float |
Sum of material and running cost. Null if material_cost and running_cost are empty |
updated | iso-8601 datetime |
When piece actuals record was updated last time |
uri | URI |
The URI of the piece actuals record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested piece actuals cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When piece actuals record was created Required |
end_in_progress_time | iso-8601 datetime |
When piece was completed (last print of this piece is completed).Can be null if not completed yet or time can't be recognized. Required |
per_step_details | array |
List of process steps of this piece. Required Example: '[{}]'
|
piece | URI |
The URI of the related piece Required |
start_in_progress_time | iso-8601 datetime |
When piece was started (status of first print was changed to in progress). Required |
total_cost | float |
Sum of material and running cost. Null if material_cost and running_cost are empty Required |
updated | iso-8601 datetime |
When piece actuals record was updated last time Required |
uri | URI |
The URI of the piece actuals record. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested piece actuals cannot be found. |
405 |
|
This contains the log of what has actually happened for a piece.
There is no API to create/edit resource, resources are created automatically when print actuals is created. Print Actuals are created from RunActuals, when run goes into in-progress state.
Get an piece actuals by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When piece actuals record was created |
end_in_progress_time | iso-8601 datetime |
When piece was completed (last print of this piece is completed).Can be null if not completed yet or time can't be recognized. |
per_step_details | array |
List of process steps of this piece. Example: '[{}]'
|
piece | URI |
The URI of the related piece |
start_in_progress_time | iso-8601 datetime |
When piece was started (status of first print was changed to in progress). |
total_cost | float |
Sum of material and running cost. Null if material_cost and running_cost are empty |
updated | iso-8601 datetime |
When piece actuals record was updated last time |
uri | URI |
The URI of the piece actuals record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested piece actuals cannot be found. |
405 |
|
/piece/
A piece represents a physical object we are manufacturing. It has 3 main relationships:
- to line_item
(+legacy piece.copy) to track what manufacturing request it is making;
- to many print
objects, for the result of each production step during manufacturing;
- to a workflow
showing how it is manufactured.
The line_item
data is the starting value for most piece data but because of things workflow
,
materials
(this is not planned yet and unclear), or details can change during manufacturing process.
NOTE: print
objects are output of run
data. See tables.py for more info.
List all of the print in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
available_for_printer | URI |
Filter pieces available for manufacturing in specific printer. |
copy | integer |
Legacy field, do not use. Legacy unique piece selector by unique |
created | iso-8601 datetime |
Datetime when piece was created (in UTC). |
current_print | URI |
URI of the current print in piece. |
current_step_position | integer |
Step position of a print which currently in-progress or queued as a next, or, if all prints completed, last print.process_step_position; or first, if piece manufacturing not scheduled yet. |
external_print_analysis | object |
none available Example: '{"type": "nebumind"}'
|
is_line_item_deleted | boolean |
True if piece's line item was deleted. |
is_order_deleted | boolean |
True if piece -> line item -> order was deleted. |
layer_thickness | float |
The layer thickness of the print in mm. Must be 0 < layer_thickness < 1. |
line_item | URI |
The URI of piece's line item. |
line_item_status | string |
The status of piece's line item. Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
location | URI |
Manufacturing location. Defaults to order.location (piece -> line item -> order). |
material | URI |
URI of related line_item's base material. |
material_name | string |
Name of related line-item's base material |
model | URI |
The URI of piece -> line item -> model. |
name | string |
Piece name is composed of model_name and copy number. |
no_model_upload | boolean |
flag on related line_item to specify that model shouldn't be uploaded |
notes | string |
Notes for the piece (currently not supported and always nullable). |
order | URI |
The order URI of piece -> line item -> order. |
order_due_date | iso-8601 datetime |
The due date of related order |
order_name | string |
The order name of piece -> line item -> order. |
owner | URI |
The URI of the order owner. |
priority | integer |
The priority score for the piece, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
remanufactured_to | URI |
If this piece failed during manufacturing, then the piece URI of the replacement (remanufactured) object. Usually null. |
size | integer |
The bounding box volume (in mm3) of the print item (x * y * z model dimensions) |
status | string |
Status of piece. Choices
'"new|confirmed|queued-for-printing|printing|queued-for-post-processing|post-processing|queued-for-shipping|shipping|complete|incomplete|cancelled|error"'
|
type | string |
Type of the Piece. Choices
'"product|specimen|waste|tooling"'
|
updated | iso-8601 datetime |
The date when the Piece was updated |
uri | URI |
The URI of this piece. |
workflow | URI |
The workflow for this piece. Defaults to parent line_item.workflow, but can change during production. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested piece cannot be found. |
/piece/{uuid}/
A piece represents a physical object we are manufacturing. It has 3 main relationships:
- to line_item
(+legacy piece.copy) to track what manufacturing request it is making;
- to many print
objects, for the result of each production step during manufacturing;
- to a workflow
showing how it is manufactured.
The line_item
data is the starting value for most piece data but because of things workflow
,
materials
(this is not planned yet and unclear), or details can change during manufacturing process.
NOTE: print
objects are output of run
data. See tables.py for more info.
Schema (application/json)
Property | Type | Description |
---|---|---|
available_for_printer | URI |
Filter pieces available for manufacturing in specific printer. |
copy | integer |
Legacy field, do not use. Legacy unique piece selector by unique |
created | iso-8601 datetime |
Datetime when piece was created (in UTC). |
current_print | URI |
URI of the current print in piece. |
current_step_position | integer |
Step position of a print which currently in-progress or queued as a next, or, if all prints completed, last print.process_step_position; or first, if piece manufacturing not scheduled yet. |
external_print_analysis | object |
none available Example: '{"type": "nebumind"}'
|
is_line_item_deleted | boolean |
True if piece's line item was deleted. |
is_order_deleted | boolean |
True if piece -> line item -> order was deleted. |
layer_thickness | float |
The layer thickness of the print in mm. Must be 0 < layer_thickness < 1. |
line_item | URI |
The URI of piece's line item. |
line_item_status | string |
The status of piece's line item. Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
location | URI |
Manufacturing location. Defaults to order.location (piece -> line item -> order). |
material | URI |
URI of related line_item's base material. |
material_name | string |
Name of related line-item's base material |
model | URI |
The URI of piece -> line item -> model. |
name | string |
Piece name is composed of model_name and copy number. |
no_model_upload | boolean |
flag on related line_item to specify that model shouldn't be uploaded |
notes | string |
Notes for the piece (currently not supported and always nullable). |
order | URI |
The order URI of piece -> line item -> order. |
order_due_date | iso-8601 datetime |
The due date of related order |
order_name | string |
The order name of piece -> line item -> order. |
owner | URI |
The URI of the order owner. |
priority | integer |
The priority score for the piece, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
remanufactured_to | URI |
If this piece failed during manufacturing, then the piece URI of the replacement (remanufactured) object. Usually null. |
size | integer |
The bounding box volume (in mm3) of the print item (x * y * z model dimensions) |
status | string |
Status of piece. Choices
'"new|confirmed|queued-for-printing|printing|queued-for-post-processing|post-processing|queued-for-shipping|shipping|complete|incomplete|cancelled|error"'
|
type | string |
Type of the Piece. Choices
'"product|specimen|waste|tooling"'
|
updated | iso-8601 datetime |
The date when the Piece was updated |
uri | URI |
The URI of this piece. |
workflow | URI |
The workflow for this piece. Defaults to parent line_item.workflow, but can change during production. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested piece cannot be found. |
/post-processor-type/
This resource defines a type of post-processing a bureau can handle. Examples might include painting, caustic bath, sanding, milling or other processes that refine a part before final delivery to a customer.
After creating a post-processor type you'll want to create instances of post-processors that satisfy the type in particular
locations via the post-processor
API
List all of the post-processor-types in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
active_post_processors | array |
URI of all active post-processors of this post-processor-type in this bureau. Example: '["..."]'
|
archived | iso-8601 datetime |
The date the post-processor-type was archived. |
archived_post_processors | array |
URI of all archived post-processors referenced in traceability report or historic data. Example: '["..."]'
|
batching_strategy | string |
Batching Strategy which describe how should be grouped Prints for Run with this Post Processor type. Choices
'"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single|by_job"'
|
build_volume | object |
Dimensions of the build volume in millimeters. Used when Example: '{}'
|
cost | float |
The cost of the post processor per minute |
description | string |
Description of the post-processor-type. |
duration | timedelta |
The length of time it will take to complete post process in seconds. |
edit_group | URI |
The URI of the custom-group with access to make changes for this resource. Empty if can be edited without restrictions. |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the post processors of this type. |
manufacturer | URI |
Manufacturer of the post-processor-type |
materials | array |
The URI of materials from the manufacturer. Example: '["..."]'
|
min_packing_distance | float |
Min distance between Parts. Used when |
name | string |
Name of the post-processor-type. |
number_of_parts | integer |
Max number of Prints in Run. Used when |
overhead_cost_per_piece_in_run | float |
The each run cost it takes to handle a single piece in a single run of this type. |
overhead_cost_per_run | float |
The each run cost it takes for each run at this workstation |
special_type | string |
Can set a workstation to be a review workstation, for review/approval automation. One of each type allowed per bureau. Choices
'"non_conformance_review"'
|
uri | URI |
The URI of the post-processor-type. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
You cannot delete this post_processor_type because there are post processors associated with it. Delete all post processors of this type first. The requested post processor type name already exists.
The value you provided for materials does not appear to be a valid material |
403 |
You are not authorized to complete the request. |
404 |
The requested post-processor-type cannot be found. |
Create a new post-processor-type.
Schema (application/json)
Property | Type | Description |
---|---|---|
active_post_processors | array |
URI of all active post-processors of this post-processor-type in this bureau. Required Example: '["..."]'
|
archived | iso-8601 datetime |
The date the post-processor-type was archived. Required |
archived_post_processors | array |
URI of all archived post-processors referenced in traceability report or historic data. Required Example: '["..."]'
|
batching_strategy | string |
Batching Strategy which describe how should be grouped Prints for Run with this Post Processor type. Default: match_previous Choices
'"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single|by_job"'
|
build_volume | object |
Dimensions of the build volume in millimeters. Used when Required Example: '{}'
|
cost | float |
The cost of the post processor per minute Default: None |
description | string |
Description of the post-processor-type. Required |
duration | timedelta |
The length of time it will take to complete post process in seconds. Required |
edit_group | URI |
The URI of the custom-group with access to make changes for this resource. Empty if can be edited without restrictions. Default: None |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. Required |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. Required |
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the post processors of this type. Default: 10 |
manufacturer | URI |
Manufacturer of the post-processor-type Required |
materials | array |
The URI of materials from the manufacturer. Required Example: '["..."]'
|
min_packing_distance | float |
Min distance between Parts. Used when Default: None |
name | string |
Name of the post-processor-type. Required |
number_of_parts | integer |
Max number of Prints in Run. Used when Default: None |
overhead_cost_per_piece_in_run | float |
The each run cost it takes to handle a single piece in a single run of this type. Default: 0 |
overhead_cost_per_run | float |
The each run cost it takes for each run at this workstation Default: 0 |
special_type | string |
Can set a workstation to be a review workstation, for review/approval automation. One of each type allowed per bureau. Default: None Choices
'"non_conformance_review"'
|
uri | URI |
The URI of the post-processor-type. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
You cannot delete this post_processor_type because there are post processors associated with it. Delete all post processors of this type first. The requested post processor type name already exists.
The value you provided for materials does not appear to be a valid material |
403 |
You are not authorized to complete the request. |
404 |
The requested post-processor-type cannot be found. |
This resource defines a type of post-processing a bureau can handle. Examples might include painting, caustic bath, sanding, milling or other processes that refine a part before final delivery to a customer.
After creating a post-processor type you'll want to create instances of post-processors that satisfy the type in particular
locations via the post-processor
API
Get a single post-processor-type.
Schema (application/json)
Property | Type | Description |
---|---|---|
active_post_processors | array |
URI of all active post-processors of this post-processor-type in this bureau. Example: '["..."]'
|
archived | iso-8601 datetime |
The date the post-processor-type was archived. |
archived_post_processors | array |
URI of all archived post-processors referenced in traceability report or historic data. Example: '["..."]'
|
batching_strategy | string |
Batching Strategy which describe how should be grouped Prints for Run with this Post Processor type. Choices
'"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single|by_job"'
|
build_volume | object |
Dimensions of the build volume in millimeters. Used when Example: '{}'
|
cost | float |
The cost of the post processor per minute |
description | string |
Description of the post-processor-type. |
duration | timedelta |
The length of time it will take to complete post process in seconds. |
edit_group | URI |
The URI of the custom-group with access to make changes for this resource. Empty if can be edited without restrictions. |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the post processors of this type. |
manufacturer | URI |
Manufacturer of the post-processor-type |
materials | array |
The URI of materials from the manufacturer. Example: '["..."]'
|
min_packing_distance | float |
Min distance between Parts. Used when |
name | string |
Name of the post-processor-type. |
number_of_parts | integer |
Max number of Prints in Run. Used when |
overhead_cost_per_piece_in_run | float |
The each run cost it takes to handle a single piece in a single run of this type. |
overhead_cost_per_run | float |
The each run cost it takes for each run at this workstation |
special_type | string |
Can set a workstation to be a review workstation, for review/approval automation. One of each type allowed per bureau. Choices
'"non_conformance_review"'
|
uri | URI |
The URI of the post-processor-type. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
You cannot delete this post_processor_type because there are post processors associated with it. Delete all post processors of this type first. The requested post processor type name already exists.
The value you provided for materials does not appear to be a valid material |
403 |
You are not authorized to complete the request. |
404 |
The requested post-processor-type cannot be found. |
/post-processor/
Post processor is an instance of a particular post-processor. This is normally set up shortly after a
post-processor-type
and a valid location
is set up. A user who has a permission to add post-processor
for a particular bureau will be able to create an instance of post processor.
A post-processor should match to a physical device that can perform post-processing of the provided type at the provided location. post-processors are used by the system to schedule time to perform post-processing, queue orders to be worked on and keep track of material usage and availability
List all of the post-processor in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The date the post-processor was archived. |
duration | timedelta |
The length of time it will take to complete post process in seconds. |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
in_progress | array |
Realtime updated list of runs in_progress on the post-processor. Due to query complexity, GET only. Example: '["..."]'
|
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the post-processor. Read only |
is_service | boolean |
If true - this post-processor outsourced to service providers picked later at order and job creation. This is common in bureau post-processor. |
location | URI |
The URI of a valid location. Required if is_service is false. |
location_name | string |
The name of a related location. |
name | string |
The name of the post-processor. For 'is_service is False' this field is required. For 'is_service is True' this field will be ignored. |
post_processor_special_type | string |
Special Workstation type of parent post-processor Choices
'"non_conformance_review"'
|
post_processor_type | URI |
The URI of a valid post-processor-type. |
post_processor_type_name | string |
The name of the related post-processor-type. |
queue | array |
Ordered list of run URIs queued on the post processor. Example: '["..."]'
|
sub_location | URI |
The URI of the post-processor’s sub_location |
updated | iso-8601 datetime |
When the or resource was updated |
updated_by | URI |
The user that last updated this post_processor. |
uri | URI |
The URI of the post-processor. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
You cannot change the position of an already post processing job. The requested post processor name already exists. Cannot delete post-processor that has runs in queue. Remove runs before deleting post-processor.
|
403 |
You are not authorized to complete the request. Service provider user cannot edit/create post-processor. |
404 |
The requested post-processor cannot be found. |
Create a new post-processor.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The date the post-processor was archived. Required |
duration | timedelta |
The length of time it will take to complete post process in seconds. Required |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. Required |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. Required |
in_progress | array |
Realtime updated list of runs in_progress on the post-processor. Due to query complexity, GET only. Required Example: '["..."]'
|
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the post-processor. Read only Required |
is_service | boolean |
If true - this post-processor outsourced to service providers picked later at order and job creation. This is common in bureau post-processor. Default: False |
location | URI |
The URI of a valid location. Required if is_service is false. Required |
location_name | string |
The name of a related location. Required |
name | string |
The name of the post-processor. For 'is_service is False' this field is required. For 'is_service is True' this field will be ignored. Required |
post_processor_special_type | string |
Special Workstation type of parent post-processor Required Choices
'"non_conformance_review"'
|
post_processor_type | URI |
The URI of a valid post-processor-type. Required |
post_processor_type_name | string |
The name of the related post-processor-type. Required |
queue | array |
Ordered list of run URIs queued on the post processor. Default: [] Example: '["..."]'
|
sub_location | URI |
The URI of the post-processor’s sub_location Required |
updated | iso-8601 datetime |
When the or resource was updated Required |
updated_by | URI |
The user that last updated this post_processor. Required |
uri | URI |
The URI of the post-processor. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
You cannot change the position of an already post processing job. The requested post processor name already exists. Cannot delete post-processor that has runs in queue. Remove runs before deleting post-processor.
|
403 |
You are not authorized to complete the request. Service provider user cannot edit/create post-processor. |
404 |
The requested post-processor cannot be found. |
Post processor is an instance of a particular post-processor. This is normally set up shortly after a
post-processor-type
and a valid location
is set up. A user who has a permission to add post-processor
for a particular bureau will be able to create an instance of post processor.
A post-processor should match to a physical device that can perform post-processing of the provided type at the provided location. post-processors are used by the system to schedule time to perform post-processing, queue orders to be worked on and keep track of material usage and availability
Get a single post-processor by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The date the post-processor was archived. |
duration | timedelta |
The length of time it will take to complete post process in seconds. |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
in_progress | array |
Realtime updated list of runs in_progress on the post-processor. Due to query complexity, GET only. Example: '["..."]'
|
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the post-processor. Read only |
is_service | boolean |
If true - this post-processor outsourced to service providers picked later at order and job creation. This is common in bureau post-processor. |
location | URI |
The URI of a valid location. Required if is_service is false. |
location_name | string |
The name of a related location. |
name | string |
The name of the post-processor. For 'is_service is False' this field is required. For 'is_service is True' this field will be ignored. |
post_processor_special_type | string |
Special Workstation type of parent post-processor Choices
'"non_conformance_review"'
|
post_processor_type | URI |
The URI of a valid post-processor-type. |
post_processor_type_name | string |
The name of the related post-processor-type. |
queue | array |
Ordered list of run URIs queued on the post processor. Example: '["..."]'
|
sub_location | URI |
The URI of the post-processor’s sub_location |
updated | iso-8601 datetime |
When the or resource was updated |
updated_by | URI |
The user that last updated this post_processor. |
uri | URI |
The URI of the post-processor. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
You cannot change the position of an already post processing job. The requested post processor name already exists. Cannot delete post-processor that has runs in queue. Remove runs before deleting post-processor.
|
403 |
You are not authorized to complete the request. Service provider user cannot edit/create post-processor. |
404 |
The requested post-processor cannot be found. |
/prep-task-record/
Preparation Task Records is the object, which representing/contains report info (status, start_in_progress_time, start_dwell_time, end_time) for a specific task in the workflow record.
Preparation Task Record can be created only during Preparation Workflow Record create or during extending
Preparation Workflow via /replace/
.
To edit Preparation Task Records can only bureau managers and users with membership in db:prep_task.edit_group
(if db:prep_task.edit_group is null
then edit this task can all users from bureau).
Right now we supporting for update only the "status" field.
There are several rules and notes for editing status::
1. any task record can be moved to skipped
;
2. all other task records can be changed only if they are "current task record in the prep_workflow_record" and
if current_user has rights to edit it;
3. if prep task record goes to end status (skipped
or completed
),
then next task will be moved to queued
status;
4. On status change we will also change prep workflow record status;
5. IMPORTANT: If last task in the prep workflow record will be skipped/completed - related line_item
or line_items from related order (and, as the result, order itself) will goes to the pending status
and it will allow to move line_items into "confirmed" status and further.
Get a list of prep tasks records extended with info from prep tasks, prep workflow record and order.
Schema (application/json)
Property | Type | Description |
---|---|---|
actuals | object |
The actual measured timing and usage data for this record related to current time Example: '{}'
|
completed_by | URI |
User who completed (or marked as skipped) this task record. |
created_by | URI |
The user who created this task record. |
edit_group | URI |
The group which has access to edit 'pre-task' record. |
end_time | iso-8601 datetime |
The datetime when task record moved to 'complete' or 'skipped' status. |
name | string |
The name of the prep task. |
order_name | string |
Name of the related order. |
position | integer |
Prep task position in the preparation workflow (starts from 0) |
prep_task | URI |
URI of the related preparation task (linking between prep_workflow and prep_task). |
prep_task_in_workflow | uuid |
UUID if the related prep_task_in_workflow |
prep_workflow | URI |
URI of the related preparation workflow. |
prep_workflow_record | URI |
URI of the related preparation workflow record. |
shortname | string |
A shorter version of Task name, for mobile or summary UI |
start_dwell_time | iso-8601 datetime |
Datetime when task record moved to 'queued' status. |
start_in_progress_time | iso-8601 datetime |
Datetime when task record moved to 'in-progress' status. |
status | string |
Status of the preparation task record. Choices
'"new|queued|in-progress|on-hold|complete|skipped|cancelled"'
|
updated | iso-8601 datetime |
The datetime when this prep-task-record was updated. |
uri | URI |
The URI of the preparation task record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Provided status is not allowed by transformations. |
403 |
User cannot edit prep_task_record. |
404 |
The requested prep_task_record cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
actuals | object |
The actual measured timing and usage data for this record related to current time Required Example: '{}'
|
completed_by | URI |
User who completed (or marked as skipped) this task record. Required |
created_by | URI |
The user who created this task record. Required |
edit_group | URI |
The group which has access to edit 'pre-task' record. Required |
end_time | iso-8601 datetime |
The datetime when task record moved to 'complete' or 'skipped' status. Required |
name | string |
The name of the prep task. Required |
order_name | string |
Name of the related order. Required |
position | integer |
Prep task position in the preparation workflow (starts from 0) Required |
prep_task | URI |
URI of the related preparation task (linking between prep_workflow and prep_task). Required |
prep_task_in_workflow | uuid |
UUID if the related prep_task_in_workflow Required |
prep_workflow | URI |
URI of the related preparation workflow. Required |
prep_workflow_record | URI |
URI of the related preparation workflow record. Required |
shortname | string |
A shorter version of Task name, for mobile or summary UI Required |
start_dwell_time | iso-8601 datetime |
Datetime when task record moved to 'queued' status. Required |
start_in_progress_time | iso-8601 datetime |
Datetime when task record moved to 'in-progress' status. Required |
status | string |
Status of the preparation task record. Required Choices
'"new|queued|in-progress|on-hold|complete|skipped|cancelled"'
|
updated | iso-8601 datetime |
The datetime when this prep-task-record was updated. Required |
uri | URI |
The URI of the preparation task record. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Provided status is not allowed by transformations. |
403 |
User cannot edit prep_task_record. |
404 |
The requested prep_task_record cannot be found. |
Preparation Task Records is the object, which representing/contains report info (status, start_in_progress_time, start_dwell_time, end_time) for a specific task in the workflow record.
Preparation Task Record can be created only during Preparation Workflow Record create or during extending
Preparation Workflow via /replace/
.
To edit Preparation Task Records can only bureau managers and users with membership in db:prep_task.edit_group
(if db:prep_task.edit_group is null
then edit this task can all users from bureau).
Right now we supporting for update only the "status" field.
There are several rules and notes for editing status::
1. any task record can be moved to skipped
;
2. all other task records can be changed only if they are "current task record in the prep_workflow_record" and
if current_user has rights to edit it;
3. if prep task record goes to end status (skipped
or completed
),
then next task will be moved to queued
status;
4. On status change we will also change prep workflow record status;
5. IMPORTANT: If last task in the prep workflow record will be skipped/completed - related line_item
or line_items from related order (and, as the result, order itself) will goes to the pending status
and it will allow to move line_items into "confirmed" status and further.
Schema (application/json)
Property | Type | Description |
---|---|---|
actuals | object |
The actual measured timing and usage data for this record related to current time Example: '{}'
|
completed_by | URI |
User who completed (or marked as skipped) this task record. |
created_by | URI |
The user who created this task record. |
edit_group | URI |
The group which has access to edit 'pre-task' record. |
end_time | iso-8601 datetime |
The datetime when task record moved to 'complete' or 'skipped' status. |
name | string |
The name of the prep task. |
order_name | string |
Name of the related order. |
position | integer |
Prep task position in the preparation workflow (starts from 0) |
prep_task | URI |
URI of the related preparation task (linking between prep_workflow and prep_task). |
prep_task_in_workflow | uuid |
UUID if the related prep_task_in_workflow |
prep_workflow | URI |
URI of the related preparation workflow. |
prep_workflow_record | URI |
URI of the related preparation workflow record. |
shortname | string |
A shorter version of Task name, for mobile or summary UI |
start_dwell_time | iso-8601 datetime |
Datetime when task record moved to 'queued' status. |
start_in_progress_time | iso-8601 datetime |
Datetime when task record moved to 'in-progress' status. |
status | string |
Status of the preparation task record. Choices
'"new|queued|in-progress|on-hold|complete|skipped|cancelled"'
|
updated | iso-8601 datetime |
The datetime when this prep-task-record was updated. |
uri | URI |
The URI of the preparation task record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Provided status is not allowed by transformations. |
403 |
User cannot edit prep_task_record. |
404 |
The requested prep_task_record cannot be found. |
/prep-task/
This is a single Prep Task in a Prep Workflow. A Prepworkflow is the list of things to do on a Line-Item to get all data Prepared (Prep) for manufacturing to begin. A PrepWorkflow is different from Production Workflow (ProdWorkflow).
PrepWorkflow: - Line-Item, no workstations, no schedule
ProdWorkflow: - Piece and Print/run - Uses workstations, and a schedule.
Get a list of prep tasks.
Schema (application/json)
Property | Type | Description |
---|---|---|
created_by | URI |
User who created this task. |
description | string |
The description of the prep task. |
edit_group | URI |
The group which has access to edit 'pre-task' records. |
name | string |
The name of the prep task. |
shortname | string |
A shorter version of Task name, for mobile or summary UI |
source_task | URI |
URI for source task (based on which one is created current) |
uri | URI |
The URI of the prep-task. |
used_in_workflow_count | integer |
In which prep workflow this task is used |
user_estimated_dwell_time | timedelta |
User estimated work time in days |
user_estimated_work_time | timedelta |
User estimated work time in hours |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. User cannot edit/create prep-task. |
404 |
The requested prep-task cannot be found. |
Create a new prep task entity.
Note: relation for workflow (prep_task_in_workflow) should be created with workflow update
Schema (application/json)
Property | Type | Description |
---|---|---|
created_by | URI |
User who created this task. Default: None |
description | string |
The description of the prep task. Required |
edit_group | URI |
The group which has access to edit 'pre-task' records. Required |
name | string |
The name of the prep task. Required |
shortname | string |
A shorter version of Task name, for mobile or summary UI Required |
source_task | URI |
URI for source task (based on which one is created current) Required |
uri | URI |
The URI of the prep-task. Required |
used_in_workflow_count | integer |
In which prep workflow this task is used Required |
user_estimated_dwell_time | timedelta |
User estimated work time in days Required |
user_estimated_work_time | timedelta |
User estimated work time in hours Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. User cannot edit/create prep-task. |
404 |
The requested prep-task cannot be found. |
This is a single Prep Task in a Prep Workflow. A Prepworkflow is the list of things to do on a Line-Item to get all data Prepared (Prep) for manufacturing to begin. A PrepWorkflow is different from Production Workflow (ProdWorkflow).
PrepWorkflow: - Line-Item, no workstations, no schedule
ProdWorkflow: - Piece and Print/run - Uses workstations, and a schedule.
Schema (application/json)
Property | Type | Description |
---|---|---|
created_by | URI |
User who created this task. |
description | string |
The description of the prep task. |
edit_group | URI |
The group which has access to edit 'pre-task' records. |
name | string |
The name of the prep task. |
shortname | string |
A shorter version of Task name, for mobile or summary UI |
source_task | URI |
URI for source task (based on which one is created current) |
uri | URI |
The URI of the prep-task. |
used_in_workflow_count | integer |
In which prep workflow this task is used |
user_estimated_dwell_time | timedelta |
User estimated work time in days |
user_estimated_work_time | timedelta |
User estimated work time in hours |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. User cannot edit/create prep-task. |
404 |
The requested prep-task cannot be found. |
/prep-workflow-record/
Allow to create (and, as the result, start work on it) prep workflow record (with related prep task records) and fetch info about them.
Creating preparation workflow record moves related line_item(s) or/and order into in-preparation
status.
When preparation workflow record will be completed/skipped - line_item(s) or/and order will go back to pending
status.
Preparation workflow record cannot be edited directly. All changes can be done only via related objects, for example:: - "status" evaluated based on dependent db:prep_task_records; - "prep_workflow_record" can be changed (as side effect) only during replacing prep_workflow; - "line_item" (at least for now) and "order" cannot be changed.
Schema (application/json)
Property | Type | Description |
---|---|---|
line_item | URI |
Related line item URI. If not null - record related to the specific line item, otherwise - to the whole order. |
order | URI |
Related order URI. |
prep_workflow | URI |
Related preparation workflow URI. |
status | string |
Status of the preparation workflow record. Choices
'"queued|in-progress|on-hold|complete|skipped|cancelled"'
|
updated | iso-8601 datetime |
The date the workflow was updated. |
uri | URI |
The URI for preparation workflow. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Inconsistent state for one of line_items. |
404 |
The requested preparation workflow record cannot be found. |
Create a new prep workflow record entity and related prep task records.
Creation of a prep_workflow_record will moves line_item(s) or/and order status to in-preparation
.
Schema (application/json)
Property | Type | Description |
---|---|---|
line_item | URI |
Related line item URI. If not null - record related to the specific line item, otherwise - to the whole order. Required |
order | URI |
Related order URI. Required |
prep_workflow | URI |
Related preparation workflow URI. Required |
status | string |
Status of the preparation workflow record. Required Choices
'"queued|in-progress|on-hold|complete|skipped|cancelled"'
|
updated | iso-8601 datetime |
The date the workflow was updated. Required |
uri | URI |
The URI for preparation workflow. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Inconsistent state for one of line_items. |
404 |
The requested preparation workflow record cannot be found. |
Allow to create (and, as the result, start work on it) prep workflow record (with related prep task records) and fetch info about them.
Creating preparation workflow record moves related line_item(s) or/and order into in-preparation
status.
When preparation workflow record will be completed/skipped - line_item(s) or/and order will go back to pending
status.
Preparation workflow record cannot be edited directly. All changes can be done only via related objects, for example:: - "status" evaluated based on dependent db:prep_task_records; - "prep_workflow_record" can be changed (as side effect) only during replacing prep_workflow; - "line_item" (at least for now) and "order" cannot be changed.
Schema (application/json)
Property | Type | Description |
---|---|---|
line_item | URI |
Related line item URI. If not null - record related to the specific line item, otherwise - to the whole order. |
order | URI |
Related order URI. |
prep_workflow | URI |
Related preparation workflow URI. |
status | string |
Status of the preparation workflow record. Choices
'"queued|in-progress|on-hold|complete|skipped|cancelled"'
|
updated | iso-8601 datetime |
The date the workflow was updated. |
uri | URI |
The URI for preparation workflow. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Inconsistent state for one of line_items. |
404 |
The requested preparation workflow record cannot be found. |
/prep-workflow/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the preparation workflow. Example: '"First version of workflow."'
|
include_custom_workflows | boolean |
Indicates should be included custom preparation workflows for line-items/orders or not. By default, custom preparation workflows will be 'excluded'. |
line_item | URI |
URI of a line item to which preparation workflow is pinned. It means that preparation workflow was created and can be used only for this line item. |
name | string |
The name of the preparation workflow. Example: '"Workflow-0.1"'
|
order | URI |
URI of an order to which preparation workflow is pinned. It means that preparation workflow was created and can be used only for line items from this order. |
source_workflow | URI |
URI of a workflow based on which current workflow was cloned/duplicated. |
tasks_in_workflow | array |
List of preparation tasks in workflow objects (for this preparation workflow) ordered by position. Example: '[{}]'
|
type | string |
Workflow type - this is fixed value which equals to 'preparative'. |
updated | iso-8601 datetime |
The date the workflow was updated. |
uri | URI |
The URI for preparation workflow. |
usage_state | string |
Representing preparation workflow's usage state based on usage by db:line_item table.'archived' state can be passed into PUT signature to archive workflow (if it allowed by workflow usage_state). Choices
'"archived|active|can_be_safely_archived|inactive"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested workflow name already exists. |
403 |
You are not authorized to complete the request. Action not allowed by permissions or by usage_state. |
404 |
The requested workflow cannot be found. |
Create a new prep workflow entity and linking prep_tasks with workflow via tasks_in_workflow
.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the preparation workflow. Required Example: '"First version of workflow."'
|
include_custom_workflows | boolean |
Indicates should be included custom preparation workflows for line-items/orders or not. By default, custom preparation workflows will be 'excluded'. Required |
line_item | URI |
URI of a line item to which preparation workflow is pinned. It means that preparation workflow was created and can be used only for this line item. Required |
name | string |
The name of the preparation workflow. Required Example: '"Workflow-0.1"'
|
order | URI |
URI of an order to which preparation workflow is pinned. It means that preparation workflow was created and can be used only for line items from this order. Required |
source_workflow | URI |
URI of a workflow based on which current workflow was cloned/duplicated. Required |
tasks_in_workflow | array |
List of preparation tasks in workflow objects (for this preparation workflow) ordered by position. Required Example: '[{}]'
|
type | string |
Workflow type - this is fixed value which equals to 'preparative'. Required |
updated | iso-8601 datetime |
The date the workflow was updated. Required |
uri | URI |
The URI for preparation workflow. Required |
usage_state | string |
Representing preparation workflow's usage state based on usage by db:line_item table.'archived' state can be passed into PUT signature to archive workflow (if it allowed by workflow usage_state). Required Choices
'"archived|active|can_be_safely_archived|inactive"'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested workflow name already exists. |
403 |
You are not authorized to complete the request. Action not allowed by permissions or by usage_state. |
404 |
The requested workflow cannot be found. |
Provides possibility to replace an active preparation workflows or copy and pin workflow into line item/order level.
I. For line_item level and order level workflow we do next steps (line_item is not None or order is not None)::
- checking permissions by fetching source preparation workflow
and line_item/order;
- ensure, that line_item or line_items from order has allowed for "replace workflow" state;
- maybe updating name
for new preparation workflow to avoid constraint error
(if the user transferred a name, it is on his conscience);
- building payload and creating new preparation workflow with permissions on it;
- create prep_tasks_in_workflow
(if validation for this field in the payload not failed;
note: if preparation workflow record
already exits - user can edit/add/delete prep_tasks_in_workflow only after
a current task), based on payload, and update (if prep_workflow_record is not None
) field prep_task_in_workflow
in related preparation task records;
- if prep_workflow_record
exists - update prep_workflow
field for it;
- updating line_item or line_items for the order with new preparation workflow;
II. for common workflows we do next steps (line_item is None and order is None
) [Not finished yet]
- checking permissions by fetching source preparation workflow
;
- checking preparation workflow usage_state - this operation available only for active
preparation workflows;
- updating source preparation workflow
name to avoid constraint error (if the user transferred a name, it is on his conscience)
and mark it as archived
(with utc_now datetime);
- building payload and creating new preparation workflow with permission on it;
- updating bureau_settings.default_prep_workflow - if it using source preparation workflow
;
- updating line_items which using source preparation workflow and have statuses "new",
"calculating_estimates" or "pending" and have no associated prep_workflow_record
(last case means,
that prep_workflow_record was finished and line_item(s) goes to "pending" status - we should not change
prep_workflow in this case
).
Replaces source preparation workflow with newly created workflow.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the replacement preparation workflow. Required |
line_item | URI |
URI of the line item to which preparation workflow is pinned. It means that preparation workflow was created and can be used only for this line item. Required |
name | string |
The name of the preparation workflow. Required Example: '"Workflow-0.2"'
|
order | URI |
URI of the order to which preparation workflow is pinned. It means that preparation workflow must be created and can be used only for line items from this order. Required |
tasks_in_workflow | array |
List of preparation tasks in workflow objects (for this preparation workflow) ordered by position. Required Example: '[{}]'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested workflow name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested preparation workflow or another related resource cannot be found. |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the preparation workflow. Example: '"First version of workflow."'
|
include_custom_workflows | boolean |
Indicates should be included custom preparation workflows for line-items/orders or not. By default, custom preparation workflows will be 'excluded'. |
line_item | URI |
URI of a line item to which preparation workflow is pinned. It means that preparation workflow was created and can be used only for this line item. |
name | string |
The name of the preparation workflow. Example: '"Workflow-0.1"'
|
order | URI |
URI of an order to which preparation workflow is pinned. It means that preparation workflow was created and can be used only for line items from this order. |
source_workflow | URI |
URI of a workflow based on which current workflow was cloned/duplicated. |
tasks_in_workflow | array |
List of preparation tasks in workflow objects (for this preparation workflow) ordered by position. Example: '[{}]'
|
type | string |
Workflow type - this is fixed value which equals to 'preparative'. |
updated | iso-8601 datetime |
The date the workflow was updated. |
uri | URI |
The URI for preparation workflow. |
usage_state | string |
Representing preparation workflow's usage state based on usage by db:line_item table.'archived' state can be passed into PUT signature to archive workflow (if it allowed by workflow usage_state). Choices
'"archived|active|can_be_safely_archived|inactive"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested workflow name already exists. |
403 |
You are not authorized to complete the request. Action not allowed by permissions or by usage_state. |
404 |
The requested workflow cannot be found. |
/print/
A print resource represents a single output from a single proces-step in a workflow. Note that this name is a legacy name, from when it was a single print to be performed by a 3D printer.
Now it is used for as the 'status of a process-step on a single piece' . So if a
line-item
has multiple copies requested then there will be a separate print
for each of those copies, for each step in the current workflow.
List all of the print in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
base_material | uuid |
Base material of attached line-item. |
bureau | URI |
The URI of print's bureau. |
copy | integer |
Copy number in the quantity the print belongs to. If a customer requests 4 copies there will be 4 separate prints and each will have a different |
filter_by_line_item_status | boolean |
Filter prints by line-item statuses |
layer_thickness | float |
The layer thickness of the print in mm. Must be 0 < layer_thickness < 1. |
line_item | URI |
The URI of print's line item. |
location | uuid |
Location of attached order. |
material_name | string |
Name of material |
name | string |
The autogenerated name of the print |
order | URI |
The URI of print's order. |
order_due_date | string |
The due date of order |
order_name | string |
The name of print's order. |
order_step_status | string |
Status of the order step. Choices
'"complete|error|new|processing"'
|
piece | URI |
The URI of the piece this print is tied to. |
piece_priority | integer |
The priority score of a related piece, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
printer | uuid |
Printer UUID |
process_step | URI |
The URI of the process step this print is tied to/ at. Read Only, joined from a peer data table. |
process_step_position | integer |
Step position in the workflow this print is running through. Read Only, joined from a peer data table. |
remanufactured_to | uuid |
UUID of print, to which this one was remanufactured to. |
run | URI |
The URI of print's run, if any. Prints are eventually collected together in a run to be manufactured by a specific printer. If this value is |
size | integer |
The size of print item |
status | string |
Status of the print. |
type | string |
Type of the Print Choices
'"product|specimen|waste|tooling"'
|
uri | URI |
The URI of the print. |
work_needed | boolean |
Filter prints depending on what in remanufactured_to field |
workflow | URI |
The workflow this print is running through. Read Only, joined from a peer data table. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested print cannot be found. |
/print/{uuid}/
A print resource represents a single output from a single proces-step in a workflow. Note that this name is a legacy name, from when it was a single print to be performed by a 3D printer.
Now it is used for as the 'status of a process-step on a single piece' . So if a
line-item
has multiple copies requested then there will be a separate print
for each of those copies, for each step in the current workflow.
Get a single print by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
base_material | uuid |
Base material of attached line-item. |
bureau | URI |
The URI of print's bureau. |
copy | integer |
Copy number in the quantity the print belongs to. If a customer requests 4 copies there will be 4 separate prints and each will have a different |
filter_by_line_item_status | boolean |
Filter prints by line-item statuses |
layer_thickness | float |
The layer thickness of the print in mm. Must be 0 < layer_thickness < 1. |
line_item | URI |
The URI of print's line item. |
location | uuid |
Location of attached order. |
material_name | string |
Name of material |
name | string |
The autogenerated name of the print |
order | URI |
The URI of print's order. |
order_due_date | string |
The due date of order |
order_name | string |
The name of print's order. |
order_step_status | string |
Status of the order step. Choices
'"complete|error|new|processing"'
|
piece | URI |
The URI of the piece this print is tied to. |
piece_priority | integer |
The priority score of a related piece, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
printer | uuid |
Printer UUID |
process_step | URI |
The URI of the process step this print is tied to/ at. Read Only, joined from a peer data table. |
process_step_position | integer |
Step position in the workflow this print is running through. Read Only, joined from a peer data table. |
remanufactured_to | uuid |
UUID of print, to which this one was remanufactured to. |
run | URI |
The URI of print's run, if any. Prints are eventually collected together in a run to be manufactured by a specific printer. If this value is |
size | integer |
The size of print item |
status | string |
Status of the print. |
type | string |
Type of the Print Choices
'"product|specimen|waste|tooling"'
|
uri | URI |
The URI of the print. |
work_needed | boolean |
Filter prints depending on what in remanufactured_to field |
workflow | URI |
The workflow this print is running through. Read Only, joined from a peer data table. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested print cannot be found. |
/printer-type/
A printer type defines a pattern to be used by printer
resources. Usually a printer-type
should correspond
to the model of a printer the bureau owns and operates. build_volume
information is used for capacity planning
and to lay out models together to fill a build area for better efficiency. The materials
property identifies
which types of materials the printer can consume when building a part and is used to match orders up with printer
capabilities for scheduling
Without filters - list all of printer-types in the system for user's bureau.
By default - will return all records for Bureau and exclude all templates.
If passed is_template == True
- will return only shared between bureaus records
and will exclude printer-types for current user bureau.
Schema (application/json)
Property | Type | Description |
---|---|---|
base_template | URI |
Indicates the URI of Printer Type (from the shared library with |
build_packer_type | string |
The type of packing supported by this printer. Choices
'"pack2d|pack3d|user_managed|pack3d_premium"'
|
build_volume | object |
Dimensions of the build volume in millimeters. Example: '{}'
|
constant_overhead | float |
A constant overhead used for the printing process. |
description | string |
Description of the printer-type. |
edit_group | URI |
The URI of the custom-group with access to make changes for this resource. Empty if can be edited without restrictions |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the printers of this type. Read only |
infill_strategies | array |
A list of infill strategies URIs that this printer can use. Example: '["..."]'
|
is_template | boolean |
Indicates, that this |
manufacturer | URI |
Manufacturer of the printer |
manufacturing_process | string |
Additive Manufacturing process in which this material can be used. Choices
('"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet '
'Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL|SLM_DMLS|LCD SLA"')
|
material_cost_scale_factor | integer |
A scaling factor multiplied with material cost |
material_mode | string |
The operation mode of the printer, this defines if the printer can mix material in the same run or same piece or if it doesn't support material mixing at all Choices
'"single_material|multiple_material_per_run"'
|
materials | array |
A list of material URIs that this printer can use. Both support and base materials should be included in this list Example: '["..."]'
|
min_packing_distance | float |
The minimum spacing required between packed models. |
name | string |
Name of the printer-type, such as Fortus 250 or ProJet 660 |
overhead_per_line_item | float |
Overhead cost per line item |
print_cost_scale_factor | integer |
A scaling factor multiplied with print cost |
running_cost_per_hour | float |
The cost for running the printer type per hour. |
support_strategies | array |
A list of support strategies URIs that this printer can use. Example: '["..."]'
|
time_after_print | timedelta |
Buffer time after printing process in seconds. |
time_before_print | timedelta |
Buffer time before printing will start in seconds. |
type | string |
Technology used by the printer such as DLMS or FDM |
uri | URI |
The URI of the printer-type. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested printer type name already exists. You cannot delete this printer_type because there are printers associated with it. Delete all printers of this type first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The value you provided for materials does not appear to be a valid material |
403 |
You are not authorized to complete the request. |
404 |
The requested printer type cannot be found. |
Create a new printer-type.
Schema (application/json)
Property | Type | Description |
---|---|---|
base_template | URI |
Indicates the URI of Printer Type (from the shared library with Required |
build_packer_type | string |
The type of packing supported by this printer. Default: pack2d Choices
'"pack2d|pack3d|user_managed|pack3d_premium"'
|
build_volume | object |
Dimensions of the build volume in millimeters. Required Example: '{}'
|
constant_overhead | float |
A constant overhead used for the printing process. Default: None |
description | string |
Description of the printer-type. Required |
edit_group | URI |
The URI of the custom-group with access to make changes for this resource. Empty if can be edited without restrictions Default: None |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. Required |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. Required |
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the printers of this type. Read only Required |
infill_strategies | array |
A list of infill strategies URIs that this printer can use. Default: [] Example: '["..."]'
|
is_template | boolean |
Indicates, that this Required |
manufacturer | URI |
Manufacturer of the printer Required |
manufacturing_process | string |
Additive Manufacturing process in which this material can be used. Default: None Choices
('"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet '
'Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL|SLM_DMLS|LCD SLA"')
|
material_cost_scale_factor | integer |
A scaling factor multiplied with material cost Default: 1 |
material_mode | string |
The operation mode of the printer, this defines if the printer can mix material in the same run or same piece or if it doesn't support material mixing at all Default: single_material Choices
'"single_material|multiple_material_per_run"'
|
materials | array |
A list of material URIs that this printer can use. Both support and base materials should be included in this list Required Example: '["..."]'
|
min_packing_distance | float |
The minimum spacing required between packed models. Default: 5 |
name | string |
Name of the printer-type, such as Fortus 250 or ProJet 660 Required |
overhead_per_line_item | float |
Overhead cost per line item Default: None |
print_cost_scale_factor | integer |
A scaling factor multiplied with print cost Default: 1 |
running_cost_per_hour | float |
The cost for running the printer type per hour. Default: None |
support_strategies | array |
A list of support strategies URIs that this printer can use. Default: [] Example: '["..."]'
|
time_after_print | timedelta |
Buffer time after printing process in seconds. Default: 0 |
time_before_print | timedelta |
Buffer time before printing will start in seconds. Default: 0 |
type | string |
Technology used by the printer such as DLMS or FDM Default: None |
uri | URI |
The URI of the printer-type. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested printer type name already exists. You cannot delete this printer_type because there are printers associated with it. Delete all printers of this type first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The value you provided for materials does not appear to be a valid material |
403 |
You are not authorized to complete the request. |
404 |
The requested printer type cannot be found. |
Clone Printer Type to the bureau level from the template (shared) Printer Type
Schema (application/json)
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested printer type cannot be found. |
A printer type defines a pattern to be used by printer
resources. Usually a printer-type
should correspond
to the model of a printer the bureau owns and operates. build_volume
information is used for capacity planning
and to lay out models together to fill a build area for better efficiency. The materials
property identifies
which types of materials the printer can consume when building a part and is used to match orders up with printer
capabilities for scheduling
Get a single printer-type by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
base_template | URI |
Indicates the URI of Printer Type (from the shared library with |
build_packer_type | string |
The type of packing supported by this printer. Choices
'"pack2d|pack3d|user_managed|pack3d_premium"'
|
build_volume | object |
Dimensions of the build volume in millimeters. Example: '{}'
|
constant_overhead | float |
A constant overhead used for the printing process. |
description | string |
Description of the printer-type. |
edit_group | URI |
The URI of the custom-group with access to make changes for this resource. Empty if can be edited without restrictions |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the printers of this type. Read only |
infill_strategies | array |
A list of infill strategies URIs that this printer can use. Example: '["..."]'
|
is_template | boolean |
Indicates, that this |
manufacturer | URI |
Manufacturer of the printer |
manufacturing_process | string |
Additive Manufacturing process in which this material can be used. Choices
('"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet '
'Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL|SLM_DMLS|LCD SLA"')
|
material_cost_scale_factor | integer |
A scaling factor multiplied with material cost |
material_mode | string |
The operation mode of the printer, this defines if the printer can mix material in the same run or same piece or if it doesn't support material mixing at all Choices
'"single_material|multiple_material_per_run"'
|
materials | array |
A list of material URIs that this printer can use. Both support and base materials should be included in this list Example: '["..."]'
|
min_packing_distance | float |
The minimum spacing required between packed models. |
name | string |
Name of the printer-type, such as Fortus 250 or ProJet 660 |
overhead_per_line_item | float |
Overhead cost per line item |
print_cost_scale_factor | integer |
A scaling factor multiplied with print cost |
running_cost_per_hour | float |
The cost for running the printer type per hour. |
support_strategies | array |
A list of support strategies URIs that this printer can use. Example: '["..."]'
|
time_after_print | timedelta |
Buffer time after printing process in seconds. |
time_before_print | timedelta |
Buffer time before printing will start in seconds. |
type | string |
Technology used by the printer such as DLMS or FDM |
uri | URI |
The URI of the printer-type. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested printer type name already exists. You cannot delete this printer_type because there are printers associated with it. Delete all printers of this type first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The value you provided for materials does not appear to be a valid material |
403 |
You are not authorized to complete the request. |
404 |
The requested printer type cannot be found. |
/printer/
A printer is an instance of a printer-type
in a particular location. It should correspond to a physical
machine used for printing parts. Printers are used to queue and schedule work and get status information about
prints to be performed to satisfy orders
List all of the printer in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The date the printer was archived. |
available_at | iso-8601 datetime |
Calculated (dynamically) datetime when printer will be available; calculated based on run schedules and printer downtimes. |
description | string |
Description of printer |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
in_progress | array |
Realtime updated list of runs in_progress on the printer. Due to query complexity, GET only. Example: '["..."]'
|
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the printer. Read only |
location | URI |
The URI of the printer's location. |
modeler | URI |
A URI from the Machine Analytics service for a modeler. This URI will be used to capture updates from Machine Analytics and apply the data to this printer |
name | string |
Name of the printer. |
printer_type | URI |
The URI of the printer type. |
queue | array |
Ordered list of run URIs queued on the printer. Example: '["..."]'
|
sub_location | URI |
The URI of the printer’s sub_location |
updated | iso-8601 datetime |
The date the printer was updated. |
updated_by | URI |
The user that last updated the printer. |
uri | URI |
The URI of the printer. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
You cannot change the position of an already printing job. The requested printer name already exists. Cannot delete printer that has runs in queue. Remove runs before deleting printer. Cannot delete printer that has registered prints or active runs. Remove them before deleting printer.
|
403 |
You are not authorized to complete the request. |
404 |
The requested printer cannot be found. |
Create a new printer.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The date the printer was archived. Required |
available_at | iso-8601 datetime |
Calculated (dynamically) datetime when printer will be available; calculated based on run schedules and printer downtimes. Required |
description | string |
Description of printer Default: None |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. Required |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. Required |
in_progress | array |
Realtime updated list of runs in_progress on the printer. Due to query complexity, GET only. Required Example: '["..."]'
|
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the printer. Read only Required |
location | URI |
The URI of the printer's location. Required |
modeler | URI |
A URI from the Machine Analytics service for a modeler. This URI will be used to capture updates from Machine Analytics and apply the data to this printer Default: None |
name | string |
Name of the printer. Required |
printer_type | URI |
The URI of the printer type. Required |
queue | array |
Ordered list of run URIs queued on the printer. Default: [] Example: '["..."]'
|
sub_location | URI |
The URI of the printer’s sub_location Required |
updated | iso-8601 datetime |
The date the printer was updated. Required |
updated_by | URI |
The user that last updated the printer. Required |
uri | URI |
The URI of the printer. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
You cannot change the position of an already printing job. The requested printer name already exists. Cannot delete printer that has runs in queue. Remove runs before deleting printer. Cannot delete printer that has registered prints or active runs. Remove them before deleting printer.
|
403 |
You are not authorized to complete the request. |
404 |
The requested printer cannot be found. |
/printer/{uuid}/
A printer is an instance of a printer-type
in a particular location. It should correspond to a physical
machine used for printing parts. Printers are used to queue and schedule work and get status information about
prints to be performed to satisfy orders
Get a single printer by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The date the printer was archived. |
available_at | iso-8601 datetime |
Calculated (dynamically) datetime when printer will be available; calculated based on run schedules and printer downtimes. |
description | string |
Description of printer |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
in_progress | array |
Realtime updated list of runs in_progress on the printer. Due to query complexity, GET only. Example: '["..."]'
|
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the printer. Read only |
location | URI |
The URI of the printer's location. |
modeler | URI |
A URI from the Machine Analytics service for a modeler. This URI will be used to capture updates from Machine Analytics and apply the data to this printer |
name | string |
Name of the printer. |
printer_type | URI |
The URI of the printer type. |
queue | array |
Ordered list of run URIs queued on the printer. Example: '["..."]'
|
sub_location | URI |
The URI of the printer’s sub_location |
updated | iso-8601 datetime |
The date the printer was updated. |
updated_by | URI |
The user that last updated the printer. |
uri | URI |
The URI of the printer. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
You cannot change the position of an already printing job. The requested printer name already exists. Cannot delete printer that has runs in queue. Remove runs before deleting printer. Cannot delete printer that has registered prints or active runs. Remove them before deleting printer.
|
403 |
You are not authorized to complete the request. |
404 |
The requested printer cannot be found. |
/process-provider/
This endpoint provides possibility to request service provider
to outsource post-processing
operations for the bureau post-processor
(with is_service is True) and track this relationships.
As the result - it will provide possibility for bureau users outsource process steps
from the workflow for line-items to this service provider.
The common flow for regular bureau users next:: 1. Bureau user creates outsource/service post-processor. 2. The Bureau user goes to post-processor from p.1, see the list of available service providers (created by this bureau), and can request from this service providers to outsource this post-processing operation. 3. [in the future] Bureau user can inactivate some service provider from outsource operation.
Service provider users can confirm, that he can outsource this post-processing operation or decline request.
Schema (application/json)
Property | Type | Description |
---|---|---|
cost | float |
Approximate cost of the post processor per minute. |
created | iso-8601 datetime |
Datetime when process provider was requested (in UTC). |
currency | string |
Currency for the 'cost' field. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
duration | timedelta |
Approximate duration to complete post-processing operation in seconds. |
post_processor | URI |
The URI of the target outsource post-processor. |
service_provider | URI |
The URI of the bureau service-provider. |
status | string |
Status of the process provider request Choices
'"pending|active|inactive"'
|
updated | iso-8601 datetime |
Datetime when process provider was updated last time (in UTC). |
uri | URI |
The URI for process provider. |
user | URI |
The URI of the user created the process provider. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
Service provider user cannot create process provider. |
404 |
The requested Process Provider (or related record) cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
cost | float |
Approximate cost of the post processor per minute. Required |
created | iso-8601 datetime |
Datetime when process provider was requested (in UTC). Required |
currency | string |
Currency for the 'cost' field. Required Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
duration | timedelta |
Approximate duration to complete post-processing operation in seconds. Required |
post_processor | URI |
The URI of the target outsource post-processor. Required |
service_provider | URI |
The URI of the bureau service-provider. Required |
status | string |
Status of the process provider request Required Choices
'"pending|active|inactive"'
|
updated | iso-8601 datetime |
Datetime when process provider was updated last time (in UTC). Required |
uri | URI |
The URI for process provider. Required |
user | URI |
The URI of the user created the process provider. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
Service provider user cannot create process provider. |
404 |
The requested Process Provider (or related record) cannot be found. |
This endpoint provides possibility to request service provider
to outsource post-processing
operations for the bureau post-processor
(with is_service is True) and track this relationships.
As the result - it will provide possibility for bureau users outsource process steps
from the workflow for line-items to this service provider.
The common flow for regular bureau users next:: 1. Bureau user creates outsource/service post-processor. 2. The Bureau user goes to post-processor from p.1, see the list of available service providers (created by this bureau), and can request from this service providers to outsource this post-processing operation. 3. [in the future] Bureau user can inactivate some service provider from outsource operation.
Service provider users can confirm, that he can outsource this post-processing operation or decline request.
Schema (application/json)
Property | Type | Description |
---|---|---|
cost | float |
Approximate cost of the post processor per minute. |
created | iso-8601 datetime |
Datetime when process provider was requested (in UTC). |
currency | string |
Currency for the 'cost' field. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
duration | timedelta |
Approximate duration to complete post-processing operation in seconds. |
post_processor | URI |
The URI of the target outsource post-processor. |
service_provider | URI |
The URI of the bureau service-provider. |
status | string |
Status of the process provider request Choices
'"pending|active|inactive"'
|
updated | iso-8601 datetime |
Datetime when process provider was updated last time (in UTC). |
uri | URI |
The URI for process provider. |
user | URI |
The URI of the user created the process provider. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
Service provider user cannot create process provider. |
404 |
The requested Process Provider (or related record) cannot be found. |
/process-step/
Process Step endpoint offers a way to add steps in a workflow that will be used to process the order. Steps must have either a printer-type, post-processor-type or shipping type that defines their behavior. Steps can also require a technician to provide uploaded data, notes, confirmation of success or other forms of input before the step is completed
List all of the process steps in your bureau
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Example: '{}'
|
bureau | URI |
none available |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
is_service | boolean |
If true - this process step is post-processor to be outsourced; if false - this is the common process-step. |
name | string |
The name of this process_step. Example: '"ProcessStep-0.1"'
|
notes | string |
Notes requirement for user input as the process-step is completed. Choices
'"Select: optional, required or hidden"'
|
shipping_direction | string |
Shipping direction for shipment. Choices
'"bureau_to_customer|bureau_to_service_provider|service_provider_to_bureau"'
|
source_process_step | URI |
Source for process_steps, created for workflows with |
step_positions | array |
Step position in workflow, index matched to workflows list above Example: '["2"]'
|
success | string |
Does this step need a success validation from user? Choices
'"Select: optional, required or hidden"'
|
tracking_id | string |
Does this step need a tracking_id from user? Choices
'"Select: optional, required or hidden"'
|
upload | string |
Does this step need an upload from user? Choices
'"Select: optional, required or hidden"'
|
uri | URI |
The URI for Process Step resource. |
workflows | array |
List of workflows containing this process_step. Example: '["..."]'
|
workstation | URL |
The URI of the printer, post_processor, shipping exact workstation, if tied to an exact workstation |
workstation_type_uri | URL |
The URI of the process type. For example [/printer-type/, /post-processing-type/ or /shipping/, etc] |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau. The requested process_step name already exists. Cannot delete process-step that belongs to a workflow.
|
403 |
You are not authorized to complete the request. |
404 |
The requested process_step cannot be found. |
Create a new process step resource.
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Required Example: '{}'
|
bureau | URI |
none available Required |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. Required |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. Required |
is_service | boolean |
If true - this process step is post-processor to be outsourced; if false - this is the common process-step. Default: False |
name | string |
The name of this process_step. Default: None Example: '"ProcessStep-0.1"'
|
notes | string |
Notes requirement for user input as the process-step is completed. Required Choices
'"Select: optional, required or hidden"'
|
shipping_direction | string |
Shipping direction for shipment. Default: None Choices
'"bureau_to_customer|bureau_to_service_provider|service_provider_to_bureau"'
|
source_process_step | URI |
Source for process_steps, created for workflows with Required |
step_positions | array |
Step position in workflow, index matched to workflows list above Required Example: '["2"]'
|
success | string |
Does this step need a success validation from user? Required Choices
'"Select: optional, required or hidden"'
|
tracking_id | string |
Does this step need a tracking_id from user? Required Choices
'"Select: optional, required or hidden"'
|
upload | string |
Does this step need an upload from user? Required Choices
'"Select: optional, required or hidden"'
|
uri | URI |
The URI for Process Step resource. Default: None |
workflows | array |
List of workflows containing this process_step. Required Example: '["..."]'
|
workstation | URL |
The URI of the printer, post_processor, shipping exact workstation, if tied to an exact workstation Default: None |
workstation_type_uri | URL |
The URI of the process type. For example [/printer-type/, /post-processing-type/ or /shipping/, etc] Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau. The requested process_step name already exists. Cannot delete process-step that belongs to a workflow.
|
403 |
You are not authorized to complete the request. |
404 |
The requested process_step cannot be found. |
Process Step endpoint offers a way to add steps in a workflow that will be used to process the order. Steps must have either a printer-type, post-processor-type or shipping type that defines their behavior. Steps can also require a technician to provide uploaded data, notes, confirmation of success or other forms of input before the step is completed
Get an individual process step resource by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Example: '{}'
|
bureau | URI |
none available |
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
is_service | boolean |
If true - this process step is post-processor to be outsourced; if false - this is the common process-step. |
name | string |
The name of this process_step. Example: '"ProcessStep-0.1"'
|
notes | string |
Notes requirement for user input as the process-step is completed. Choices
'"Select: optional, required or hidden"'
|
shipping_direction | string |
Shipping direction for shipment. Choices
'"bureau_to_customer|bureau_to_service_provider|service_provider_to_bureau"'
|
source_process_step | URI |
Source for process_steps, created for workflows with |
step_positions | array |
Step position in workflow, index matched to workflows list above Example: '["2"]'
|
success | string |
Does this step need a success validation from user? Choices
'"Select: optional, required or hidden"'
|
tracking_id | string |
Does this step need a tracking_id from user? Choices
'"Select: optional, required or hidden"'
|
upload | string |
Does this step need an upload from user? Choices
'"Select: optional, required or hidden"'
|
uri | URI |
The URI for Process Step resource. |
workflows | array |
List of workflows containing this process_step. Example: '["..."]'
|
workstation | URL |
The URI of the printer, post_processor, shipping exact workstation, if tied to an exact workstation |
workstation_type_uri | URL |
The URI of the process type. For example [/printer-type/, /post-processing-type/ or /shipping/, etc] |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau. The requested process_step name already exists. Cannot delete process-step that belongs to a workflow.
|
403 |
You are not authorized to complete the request. |
404 |
The requested process_step cannot be found. |
/product/
Product is resource for "design and details for a things to ships to a customer'. It is child to an order and parent to line-item(s). Order = "when/who to ship this to" and Line-Item = "Design of a thing to manufacture".
We have support for multiple model types with more than one mesh inside of, so they needed to be converted to line items.
For 1-mesh files it must be only 1 product per 1 line item. For the multi-mesh model formats, there can be multiple line items for one product.
Product must be created for line item with type=product. Only 1 mesh file is implemented for now.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date when the product was created. |
model_library | URI |
Model library URI when product's line item should be created based on model library. Design file will not be expected to be created in this case. |
no_model_upload | boolean |
Is model upload required for the product or not. |
order | URI |
URI to assigned order for this product. |
updated | iso-8601 datetime |
The date when the product was updated. |
uri | URI |
none available |
user | URI |
URI of user who created this product. Null if user was deleted. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested product cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date when the product was created. Required |
model_library | URI |
Model library URI when product's line item should be created based on model library. Design file will not be expected to be created in this case. Default: None |
no_model_upload | boolean |
Is model upload required for the product or not. Default: False |
order | URI |
URI to assigned order for this product. Required |
updated | iso-8601 datetime |
The date when the product was updated. Required |
uri | URI |
none available Required |
user | URI |
URI of user who created this product. Null if user was deleted. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested product cannot be found. |
405 |
|
/product/{uuid}/
Product is resource for "design and details for a things to ships to a customer'. It is child to an order and parent to line-item(s). Order = "when/who to ship this to" and Line-Item = "Design of a thing to manufacture".
We have support for multiple model types with more than one mesh inside of, so they needed to be converted to line items.
For 1-mesh files it must be only 1 product per 1 line item. For the multi-mesh model formats, there can be multiple line items for one product.
Product must be created for line item with type=product. Only 1 mesh file is implemented for now.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date when the product was created. |
model_library | URI |
Model library URI when product's line item should be created based on model library. Design file will not be expected to be created in this case. |
no_model_upload | boolean |
Is model upload required for the product or not. |
order | URI |
URI to assigned order for this product. |
updated | iso-8601 datetime |
The date when the product was updated. |
uri | URI |
none available |
user | URI |
URI of user who created this product. Null if user was deleted. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested product cannot be found. |
405 |
|
/prosper/
This endpoint allows you to get and set information about builds that have occurred from one of your 3D printers. A build is the process of doing a print run, regardless of the number of independent CAD models that were represented in the build volume.
List all of the builds in the system for your account
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the cassette resource was created |
service_url | URL |
The URI of the printer performing the build Choices
'"s|e|r|v|i|c|e|_|u|r|l"'
|
uri | URI |
The URI for this prosper |
x_p3d_token | string |
The application token Prosper service |
x_p3d_user | string |
The user token of Prosper service |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The prosper requested cannot be found |
Create a new prosper
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the cassette resource was created Default: None |
service_url | URL |
The URI of the printer performing the build Required Choices
'"s|e|r|v|i|c|e|_|u|r|l"'
|
uri | URI |
The URI for this prosper Default: None |
x_p3d_token | string |
The application token Prosper service Required |
x_p3d_user | string |
The user token of Prosper service Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The prosper requested cannot be found |
/prosper/{uuid}/
This endpoint allows you to get and set information about builds that have occurred from one of your 3D printers. A build is the process of doing a print run, regardless of the number of independent CAD models that were represented in the build volume.
Get a single prosper by UUID
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
When the cassette resource was created |
service_url | URL |
The URI of the printer performing the build Choices
'"s|e|r|v|i|c|e|_|u|r|l"'
|
uri | URI |
The URI for this prosper |
x_p3d_token | string |
The application token Prosper service |
x_p3d_user | string |
The user token of Prosper service |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The prosper requested cannot be found |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Get all resources for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
material_name | string |
Material name |
printer_name | string |
Printer name |
uri | URI |
URI for object |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested object name already exists. |
404 |
The requested object cannot be found. |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Get an individual resource by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
material_name | string |
Material name |
printer_name | string |
Printer name |
uri | URI |
URI for object |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested object name already exists. |
404 |
The requested object cannot be found. |
/quote/
This is the main resource for Quoting price for printing a model with certain material and from a certain bureau with a currency specified.
Schema (application/json)
Property | Type | Description |
---|---|---|
actual_cost | float |
The actual cost corresponding to a /quote/ Example: '"39.45"'
|
bureau | string |
Quote price from this bureau. You get the list of bureaus from GET/bureau/ Choices
'"shapeways"'
|
callback | object |
Callback URL for price quoting result Example: '{}'
|
created | iso-8601 datetime |
Creation date of the quote Example: '"2017-01-01T00:00:00.000000"'
|
currency | string |
Currency of the price quote Choices
'"USD"'
|
edited_by | URL |
The URI of the resource (user or potentially service provider) that last edited estimates. |
error | string |
Error message from the bureau Example: '"Failed to grab pricing data"'
|
material | URI |
Quote price for this material using the material URI. You get the list of materials from GET/material/ Example: '"https://quoting.authentise.com/material/123456/"'
|
model | URI |
This URL should point to a valid model resource that has already been uploaded. Example: '"https://models.authentise.com/model/456/"'
|
model_statistics | object |
Model statistics for the model resource. Example: '{"size": {}}'
|
price | float |
Price quote for the model Example: '"100.00"'
|
process | string |
Technology used to print this model. Choices
'"FDM|SLA|DLP|EBM|SDL|Binder Jet"'
|
status | string |
Status code of the request. Possible status are: complete, error, processing, queued. Example: '"complete"'
|
uri | URI |
The URI of the /quote/ instance Example: '"https://quoting.authentise.com/quote/123456/"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
There is no matching bureau-material combination Either the model requested does not exist or you do not have permission to use The model response does not contain few or all of these fields: Size, Volume, Surface Area |
404 |
The material requested is not available with the bureau requested |
500 |
The bureau requested does not exist |
/quote/{uuid}/
This is the main resource for Quoting price for printing a model with certain material and from a certain bureau with a currency specified.
Schema (application/json)
Property | Type | Description |
---|---|---|
actual_cost | float |
The actual cost corresponding to a /quote/ Example: '"39.45"'
|
bureau | string |
Quote price from this bureau. You get the list of bureaus from GET/bureau/ Choices
'"shapeways"'
|
callback | object |
Callback URL for price quoting result Example: '{}'
|
created | iso-8601 datetime |
Creation date of the quote Example: '"2017-01-01T00:00:00.000000"'
|
currency | string |
Currency of the price quote Choices
'"USD"'
|
edited_by | URL |
The URI of the resource (user or potentially service provider) that last edited estimates. |
error | string |
Error message from the bureau Example: '"Failed to grab pricing data"'
|
material | URI |
Quote price for this material using the material URI. You get the list of materials from GET/material/ Example: '"https://quoting.authentise.com/material/123456/"'
|
model | URI |
This URL should point to a valid model resource that has already been uploaded. Example: '"https://models.authentise.com/model/456/"'
|
model_statistics | object |
Model statistics for the model resource. Example: '{"size": {}}'
|
price | float |
Price quote for the model Example: '"100.00"'
|
process | string |
Technology used to print this model. Choices
'"FDM|SLA|DLP|EBM|SDL|Binder Jet"'
|
status | string |
Status code of the request. Possible status are: complete, error, processing, queued. Example: '"complete"'
|
uri | URI |
The URI of the /quote/ instance Example: '"https://quoting.authentise.com/quote/123456/"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
There is no matching bureau-material combination Either the model requested does not exist or you do not have permission to use The model response does not contain few or all of these fields: Size, Volume, Surface Area |
404 |
The material requested is not available with the bureau requested |
500 |
The bureau requested does not exist |
Get the data for the various builds captured by the system grouped by modeler
Get all build reports by modeler, or filter by a specific start and end date
Schema (application/json)
Property | Type | Description |
---|---|---|
builds_count | integer |
The total number of builds |
builds_estimated_time | integer |
The total estimate build time |
builds_estimation_error | integer |
The average amount of estimated build time error |
builds_status_backlogged | integer |
The number of builds with the |
builds_status_cancelled | integer |
The number of builds with the |
builds_status_complete | integer |
The number of builds with the |
builds_status_error | integer |
The number of builds with the |
builds_status_failed | integer |
The number of builds with the |
builds_status_machine_error | integer |
The number of builds with the |
builds_status_new | integer |
The number of builds with the |
builds_status_part_exceeds_boundaries | integer |
The number of builds with the |
builds_status_paused | integer |
The number of builds with the |
builds_status_preheat | integer |
The number of builds with the |
builds_status_processing | integer |
The number of builds with the |
builds_status_suspended | integer |
The number of builds with the |
builds_status_unknown | integer |
The number of builds with the |
builds_status_user_abort | integer |
The number of builds with the |
builds_status_waiting_for_resolution | integer |
The number of builds with the |
builds_time | integer |
The total amount of build time |
modeler | string |
The modeler identifier |
modeler_name | string |
The modeler name |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/role/
Get and update a users role.
Role - it is extended info about users memberships (Role.uuid == Membership.uuid) in groups:
key role
contains user-friendly representation (string) for relation user -> membership <-group
.
Users can have multiple roles. For a lot of internal logic, only 'highest role is used.'
Bureau manager have access to all bureau roles and can view
, create
, edit
and delete
roles.
Other users can only view
their own roles.
Restrictions were added due to tickets: https://app.clubhouse.io/authentise/story/9154, https://app.clubhouse.io/authentise/story/8668.
Get a list of all users for a bureau and their roles
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau these roles are related to. |
emails | array |
The user's email address Example: '["..."]'
|
hide_info | string |
A single 'Hide Data' type. Editable by Bureau Manager only. Do not submit for no-change.Submit None to clear the hide-info setting. Choices
'"financial"'
|
highest_only | boolean |
This filter will returns only highest highest role for the user. Be careful: it can returns few roles, if highest user role is 'location'. |
location | URI |
The locations the user is assigned to for this role, or null if the role is not location-based |
name | string |
The human readable name of the user. |
role | string |
The role we are changing. Note that one user can have a variety of roles. Choices
'"manager|global-user|standard-user|location-user|restricted|unknown|self-registered-guest"'
|
uri | URI |
The URI of this specific role for this user. |
user | URI |
Each user has a unique username and this should be enough but this filter also allows filtering by users URI. |
username | string |
The username/account of the user |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested role cannot be found. |
Create a new 'role' for a user in a bureau
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau these roles are related to. Required |
emails | array |
The user's email address Required Example: '["..."]'
|
hide_info | string |
A single 'Hide Data' type. Editable by Bureau Manager only. Do not submit for no-change.Submit None to clear the hide-info setting. Default: None Choices
'"financial"'
|
highest_only | boolean |
This filter will returns only highest highest role for the user. Be careful: it can returns few roles, if highest user role is 'location'. Required |
location | URI |
The locations the user is assigned to for this role, or null if the role is not location-based Default: None |
name | string |
The human readable name of the user. Required |
role | string |
The role we are changing. Note that one user can have a variety of roles. Required Choices
'"manager|global-user|standard-user|location-user|restricted|unknown|self-registered-guest"'
|
uri | URI |
The URI of this specific role for this user. Required |
user | URI |
Each user has a unique username and this should be enough but this filter also allows filtering by users URI. Required |
username | string |
The username/account of the user Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested role cannot be found. |
/role/{uuid}/
Get and update a users role.
Role - it is extended info about users memberships (Role.uuid == Membership.uuid) in groups:
key role
contains user-friendly representation (string) for relation user -> membership <-group
.
Users can have multiple roles. For a lot of internal logic, only 'highest role is used.'
Bureau manager have access to all bureau roles and can view
, create
, edit
and delete
roles.
Other users can only view
their own roles.
Restrictions were added due to tickets: https://app.clubhouse.io/authentise/story/9154, https://app.clubhouse.io/authentise/story/8668.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau these roles are related to. |
emails | array |
The user's email address Example: '["..."]'
|
hide_info | string |
A single 'Hide Data' type. Editable by Bureau Manager only. Do not submit for no-change.Submit None to clear the hide-info setting. Choices
'"financial"'
|
highest_only | boolean |
This filter will returns only highest highest role for the user. Be careful: it can returns few roles, if highest user role is 'location'. |
location | URI |
The locations the user is assigned to for this role, or null if the role is not location-based |
name | string |
The human readable name of the user. |
role | string |
The role we are changing. Note that one user can have a variety of roles. Choices
'"manager|global-user|standard-user|location-user|restricted|unknown|self-registered-guest"'
|
uri | URI |
The URI of this specific role for this user. |
user | URI |
Each user has a unique username and this should be enough but this filter also allows filtering by users URI. |
username | string |
The username/account of the user |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested role cannot be found. |
/run-actuals/
This contains the log of what has actually happened in a run, vs the forecasted run time/data. Note that this is for a run overall, TimeEntry may contain more specific data on machine, labor, etc times.
A run in a collection of the same/similar work that is sent through a machine or workstation as a group.
Run endpoint contains the plan for a run (time, prints, material, etc). This contains the record of what has actually happened during that run
For example, scheduled time for the run to happen is in schedule table. The actual time the run begain is in the related run_actual.start_in_progress_time field.
Note that a run
can exist without run-actuals, run-actuals
are created when status is 'in-progress', but run-actuals require a parent run.
If data is collected, and a build created, and able to be related to a run that is OK. We can have 'build' without 'run-actuals'.
List all run actuals.
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Example: '{}'
|
by_line_item | URI |
Filter only field to filter on parent order. Lookup is Run -> Piece -> Line-Item. Not all runs have a related line-item. |
by_order | URI |
Filter only field to filter on parent order. Lookup is Run -> Piece -> Line-Item -> Order. Not all runs have a related order. |
consumable_cost | float |
Material cost of run, null if can't be determined. See platform level of RunActuals for formulas of calculation |
created | iso-8601 datetime |
Datetime when this record was created. |
edited_by | URI |
The URI of the related updated by user |
end_in_progress_time | iso-8601 datetime |
When run was completed. Can be null if not completed yet or time can't be recognized. |
machine_cost | float |
Material cost of run, null if can't be determined. See platform level of RunActuals for formulas of calculation |
powder | object |
none available Example: 'null'
|
previous | URI |
The URI of the previous / prior run-actuals. Note 'Run' is none |
run | URI |
The URI of the related run. If none, this data was replace.This is 'previous' to a newer run-actuals. |
start_in_progress_time | iso-8601 datetime |
When run was started (status is changed to in progress). |
system_notes | string |
System notes for related run changes |
total_cost | float |
Sum of material and running cost. Null if material_cost and running_cost are empty |
updated | iso-8601 datetime |
When run actuals record was updated last time |
uri | URI |
The URI of the this run-actuals record. |
user | URI |
The URI of the user that last edited this run-actual data. Not some automatic changes don't track a source user.Maybe be set as side-effect of a 'run' status change. |
workstation_cost | float |
Running cost of run, null if can't be determined. See platform level of RunActuals for formulas of calculation |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested run actuals cannot be found. |
RunActuals created in backend on events/triggers on run, or on builds, or TimeEntries. AKA cannot be POST'd to created
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Required Example: '{}'
|
by_line_item | URI |
Filter only field to filter on parent order. Lookup is Run -> Piece -> Line-Item. Not all runs have a related line-item. Required |
by_order | URI |
Filter only field to filter on parent order. Lookup is Run -> Piece -> Line-Item -> Order. Not all runs have a related order. Required |
consumable_cost | float |
Material cost of run, null if can't be determined. See platform level of RunActuals for formulas of calculation Default: None |
created | iso-8601 datetime |
Datetime when this record was created. Required |
edited_by | URI |
The URI of the related updated by user Default: None |
end_in_progress_time | iso-8601 datetime |
When run was completed. Can be null if not completed yet or time can't be recognized. Default: None |
machine_cost | float |
Material cost of run, null if can't be determined. See platform level of RunActuals for formulas of calculation Default: None |
powder | object |
none available Required Example: 'null'
|
previous | URI |
The URI of the previous / prior run-actuals. Note 'Run' is none Default: None |
run | URI |
The URI of the related run. If none, this data was replace.This is 'previous' to a newer run-actuals. Default: None |
start_in_progress_time | iso-8601 datetime |
When run was started (status is changed to in progress). Required |
system_notes | string |
System notes for related run changes Default: None |
total_cost | float |
Sum of material and running cost. Null if material_cost and running_cost are empty Default: None |
updated | iso-8601 datetime |
When run actuals record was updated last time Required |
uri | URI |
The URI of the this run-actuals record. Required |
user | URI |
The URI of the user that last edited this run-actual data. Not some automatic changes don't track a source user.Maybe be set as side-effect of a 'run' status change. Default: None |
workstation_cost | float |
Running cost of run, null if can't be determined. See platform level of RunActuals for formulas of calculation Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested run actuals cannot be found. |
This contains the log of what has actually happened in a run, vs the forecasted run time/data. Note that this is for a run overall, TimeEntry may contain more specific data on machine, labor, etc times.
A run in a collection of the same/similar work that is sent through a machine or workstation as a group.
Run endpoint contains the plan for a run (time, prints, material, etc). This contains the record of what has actually happened during that run
For example, scheduled time for the run to happen is in schedule table. The actual time the run begain is in the related run_actual.start_in_progress_time field.
Note that a run
can exist without run-actuals, run-actuals
are created when status is 'in-progress', but run-actuals require a parent run.
If data is collected, and a build created, and able to be related to a run that is OK. We can have 'build' without 'run-actuals'.
Get a run actuals by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
additive | object |
none available Example: '{}'
|
by_line_item | URI |
Filter only field to filter on parent order. Lookup is Run -> Piece -> Line-Item. Not all runs have a related line-item. |
by_order | URI |
Filter only field to filter on parent order. Lookup is Run -> Piece -> Line-Item -> Order. Not all runs have a related order. |
consumable_cost | float |
Material cost of run, null if can't be determined. See platform level of RunActuals for formulas of calculation |
created | iso-8601 datetime |
Datetime when this record was created. |
edited_by | URI |
The URI of the related updated by user |
end_in_progress_time | iso-8601 datetime |
When run was completed. Can be null if not completed yet or time can't be recognized. |
machine_cost | float |
Material cost of run, null if can't be determined. See platform level of RunActuals for formulas of calculation |
powder | object |
none available Example: 'null'
|
previous | URI |
The URI of the previous / prior run-actuals. Note 'Run' is none |
run | URI |
The URI of the related run. If none, this data was replace.This is 'previous' to a newer run-actuals. |
start_in_progress_time | iso-8601 datetime |
When run was started (status is changed to in progress). |
system_notes | string |
System notes for related run changes |
total_cost | float |
Sum of material and running cost. Null if material_cost and running_cost are empty |
updated | iso-8601 datetime |
When run actuals record was updated last time |
uri | URI |
The URI of the this run-actuals record. |
user | URI |
The URI of the user that last edited this run-actual data. Not some automatic changes don't track a source user.Maybe be set as side-effect of a 'run' status change. |
workstation_cost | float |
Running cost of run, null if can't be determined. See platform level of RunActuals for formulas of calculation |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested run actuals cannot be found. |
/run-material/
Read only API endpoint for retrieving total quantity of material used in a printing run. UUID needs to be UUID on a run for this endpoint to work.
Note: run-material is used in printing only, powder workflows should have no entries for this resource
Schema (application/json)
Property | Type | Description |
---|---|---|
materials | array |
List of materials and the amount being used. Example: '[{"type": "support|base"}]'
|
run | URI |
URI of run we want to the material usage for |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
Read only API endpoint for retrieving total quantity of material used in a printing run. UUID needs to be UUID on a run for this endpoint to work.
Note: run-material is used in printing only, powder workflows should have no entries for this resource
Schema (application/json)
Property | Type | Description |
---|---|---|
materials | array |
List of materials and the amount being used. Example: '[{"type": "support|base"}]'
|
run | URI |
URI of run we want to the material usage for |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
|
/run-queue/
/run-queue/ endpoint helps re-queuing the run provided to the API and puts it in the start of the queue. The API will schedule the run and hence the prints as the next run to be processed.
Requeue runs and make this run next to be processed.
Schema (application/json)
Property | Type | Description |
---|---|---|
run | URI |
The URI of run's which is to be re-queued. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested run cannot be found. |
/run-transformation/
This triggers complex actions on a run, which may need to run in the background. POST creates promise for the action, and runs it. GET/LIST show a record of it's success/failure. The changes here may change several resources,
Status of this endpoints is the status of the backend job doing the requested change: - pending: job is accepted, queued to run in the backend; - processing: job is running in the backend; - complete: job completed OK, no error. All resources up to date OK (any known warning can be added to the notes); - error: job did not complete OK. See notes for error/failure info.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The datetime when run transformation was created. |
custom_workflow | URI |
Custom workflow URI, created for pieces (for 'prints') during 'change_workflow' transformation. |
destination_runs | array |
List of resulting runs created or updated on workflow change. Example: '["..."]'
|
notes | string |
Notes for the transformation, usually - reason. |
prints | array |
List of prints from the 'source_run' to apply transformation into. Example: '["..."]'
|
process_steps | array |
["On change_workflow: List of all process steps in the 'new workflow'(not just new steps), created by caller. Otherwise None. tricky, sorry"] Example: '["..."]'
|
source_run | URI |
The in-progress run we are going to transform, or update pieces in. AKA 'in-progress' run. |
split_piece_schedules | boolean |
True if the schedule and runs for reworked pieces are to be separated from non-reworked pieces during run changes. |
status | string |
none available Choices
'"pending|processing|complete|error"'
|
type | string |
The type of transformation to apply to these pieces in this run. Choices
'"remanufacture|redo|change_workflow|flag_non_conformance|scrap"'
|
updated | iso-8601 datetime |
The datetime when run transformation was last updated (by person or algorithm). |
uri | URI |
This run transformation's URI. |
user | URI |
The URI of the user who makes the transformation. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
The requested run transformation or related object cannot be found. |
Creates db promise to do the requested transform. runs action in-line, or in a background task. :param payload: :return:
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The datetime when run transformation was created. Required |
custom_workflow | URI |
Custom workflow URI, created for pieces (for 'prints') during 'change_workflow' transformation. Required |
destination_runs | array |
List of resulting runs created or updated on workflow change. Required Example: '["..."]'
|
notes | string |
Notes for the transformation, usually - reason. Default: None |
prints | array |
List of prints from the 'source_run' to apply transformation into. Required Example: '["..."]'
|
process_steps | array |
["On change_workflow: List of all process steps in the 'new workflow'(not just new steps), created by caller. Otherwise None. tricky, sorry"] Required Example: '["..."]'
|
source_run | URI |
The in-progress run we are going to transform, or update pieces in. AKA 'in-progress' run. Required |
split_piece_schedules | boolean |
True if the schedule and runs for reworked pieces are to be separated from non-reworked pieces during run changes. Required |
status | string |
none available Required Choices
'"pending|processing|complete|error"'
|
type | string |
The type of transformation to apply to these pieces in this run. Required Choices
'"remanufacture|redo|change_workflow|flag_non_conformance|scrap"'
|
updated | iso-8601 datetime |
The datetime when run transformation was last updated (by person or algorithm). Required |
uri | URI |
This run transformation's URI. Required |
user | URI |
The URI of the user who makes the transformation. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
404 |
The requested run transformation or related object cannot be found. |
This triggers complex actions on a run, which may need to run in the background. POST creates promise for the action, and runs it. GET/LIST show a record of it's success/failure. The changes here may change several resources,
Status of this endpoints is the status of the backend job doing the requested change: - pending: job is accepted, queued to run in the backend; - processing: job is running in the backend; - complete: job completed OK, no error. All resources up to date OK (any known warning can be added to the notes); - error: job did not complete OK. See notes for error/failure info.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The datetime when run transformation was created. |
custom_workflow | URI |
Custom workflow URI, created for pieces (for 'prints') during 'change_workflow' transformation. |
destination_runs | array |
List of resulting runs created or updated on workflow change. Example: '["..."]'
|
notes | string |
Notes for the transformation, usually - reason. |
prints | array |
List of prints from the 'source_run' to apply transformation into. Example: '["..."]'
|
process_steps | array |
["On change_workflow: List of all process steps in the 'new workflow'(not just new steps), created by caller. Otherwise None. tricky, sorry"] Example: '["..."]'
|
source_run | URI |
The in-progress run we are going to transform, or update pieces in. AKA 'in-progress' run. |
split_piece_schedules | boolean |
True if the schedule and runs for reworked pieces are to be separated from non-reworked pieces during run changes. |
status | string |
none available Choices
'"pending|processing|complete|error"'
|
type | string |
The type of transformation to apply to these pieces in this run. Choices
'"remanufacture|redo|change_workflow|flag_non_conformance|scrap"'
|
updated | iso-8601 datetime |
The datetime when run transformation was last updated (by person or algorithm). |
uri | URI |
This run transformation's URI. |
user | URI |
The URI of the user who makes the transformation. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
The requested run transformation or related object cannot be found. |
/run/
A run corresponds to a group of pieces being worked on together (a run)
at a printer or post-processor. A run must have one or more pieces
indicating the
physical instance being worked on. A run must have a prints
for each piece
indicating the success/ failure of work on each piece. AKA print
is the output of the
operation on each piece.
The system can aggregate multiple prints together for efficiency. A run can be created without a specific printer or post-processor to indicate work that should be done in the future. Eventually the run is assigned to a particular printer or post-processor that completes the run.
Run data can be automatically updated based on reports gathered by Echo. This gives the system a full control loop for data.
See Also run-actuals.
Get all of the runs the current user has access to
Schema (application/json)
Property | Type | Description |
---|---|---|
batch_type | string |
Type of batching strategy. Choices
'"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single|by_job|by_order"'
|
by_line_item | URI |
Allows filtering runs by prints line-item, list only. |
by_order | URI |
Allows filtering runs by prints orders. |
created | iso-8601 datetime |
The datetime the records was created |
error | string |
The current error for the run, if any |
filled_by_batch_type_prints | boolean |
Is this run fully filled with necessary prints or not (supported by batch_type=by_order). Can be set/changed only by further run creator |
id | string |
The identifier for this run. This identifier will be generated when the run is created and should be the name used for the print so the sytem can track it |
location | URI |
The URI of run's location (based on printer or post-processor). |
name | string |
name of a run |
notes | string |
Notes for a run |
operation | string |
Operation type of the run. Choices
'"printing|post-processing|shipping"'
|
orders | array |
List of orders URIs (based on prints). Example: '["..."]'
|
pieces_locked | boolean |
When locked, prints cannot be added to this run |
post_processor | URI |
The URI of run's post_processor. |
post_processor_type | URI |
The URI of run's post processor type. |
printer | URI |
The URI of run's printer. |
printer_type | URI |
The URI of run's printer type. |
prints | array |
The URIs of prints in the run. Example: '["..."]'
|
priority | integer |
The priority score for the run, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
run_documents | array |
none available Example: '["..."]'
|
service_provider_jobs | array |
none available Example: '["..."]'
|
shipping | URI |
The URI of run's shipping type. |
status | string |
Status of the run. Choices
'"calculating|calculated|queued|in-progress|paused|complete|error|cancelled"'
|
updated | iso-8601 datetime |
The date the run was updated. |
uri | URI |
The URI of the run. |
workstation_name | string |
The name of the printer, post processor, or shipping type |
workstation_type_name | string |
The name of the printer type or post processor type |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Run cannot consist of The system is busy printing. Please end the current process first. The requested prints do not have their associated line_items in either confirmed or printing state. The requested prints do not have same process types belonging to process steps. All the previous steps for the order should be completed before we can process these prints. |
404 |
The requested run or related object cannot be found. |
409 |
The requested status transformation is not allowed. |
Create a new run.
Schema (application/json)
Property | Type | Description |
---|---|---|
batch_type | string |
Type of batching strategy. Default: match_previous Choices
'"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single|by_job|by_order"'
|
by_line_item | URI |
Allows filtering runs by prints line-item, list only. Required |
by_order | URI |
Allows filtering runs by prints orders. Required |
created | iso-8601 datetime |
The datetime the records was created Default: None |
error | string |
The current error for the run, if any Default: None |
filled_by_batch_type_prints | boolean |
Is this run fully filled with necessary prints or not (supported by batch_type=by_order). Can be set/changed only by further run creator Required |
id | string |
The identifier for this run. This identifier will be generated when the run is created and should be the name used for the print so the sytem can track it Default: None |
location | URI |
The URI of run's location (based on printer or post-processor). Default: None |
name | string |
name of a run Default: None |
notes | string |
Notes for a run Default: None |
operation | string |
Operation type of the run. Default: None Choices
'"printing|post-processing|shipping"'
|
orders | array |
List of orders URIs (based on prints). Required Example: '["..."]'
|
pieces_locked | boolean |
When locked, prints cannot be added to this run Default: True |
post_processor | URI |
The URI of run's post_processor. Default: None |
post_processor_type | URI |
The URI of run's post processor type. Default: None |
printer | URI |
The URI of run's printer. Default: None |
printer_type | URI |
The URI of run's printer type. Default: None |
prints | array |
The URIs of prints in the run. Required Example: '["..."]'
|
priority | integer |
The priority score for the run, in range 0-100, where 0 is the lowest priority and 100 is the highest priority Default: 65 |
run_documents | array |
none available Default: None Example: '["..."]'
|
service_provider_jobs | array |
none available Required Example: '["..."]'
|
shipping | URI |
The URI of run's shipping type. Default: None |
status | string |
Status of the run. Default: None Choices
'"calculating|calculated|queued|in-progress|paused|complete|error|cancelled"'
|
updated | iso-8601 datetime |
The date the run was updated. Required |
uri | URI |
The URI of the run. Default: None |
workstation_name | string |
The name of the printer, post processor, or shipping type Required |
workstation_type_name | string |
The name of the printer type or post processor type Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Run cannot consist of The system is busy printing. Please end the current process first. The requested prints do not have their associated line_items in either confirmed or printing state. The requested prints do not have same process types belonging to process steps. All the previous steps for the order should be completed before we can process these prints. |
404 |
The requested run or related object cannot be found. |
409 |
The requested status transformation is not allowed. |
/run/{uuid}/
A run corresponds to a group of pieces being worked on together (a run)
at a printer or post-processor. A run must have one or more pieces
indicating the
physical instance being worked on. A run must have a prints
for each piece
indicating the success/ failure of work on each piece. AKA print
is the output of the
operation on each piece.
The system can aggregate multiple prints together for efficiency. A run can be created without a specific printer or post-processor to indicate work that should be done in the future. Eventually the run is assigned to a particular printer or post-processor that completes the run.
Run data can be automatically updated based on reports gathered by Echo. This gives the system a full control loop for data.
See Also run-actuals.
Get a single run by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
batch_type | string |
Type of batching strategy. Choices
'"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single|by_job|by_order"'
|
by_line_item | URI |
Allows filtering runs by prints line-item, list only. |
by_order | URI |
Allows filtering runs by prints orders. |
created | iso-8601 datetime |
The datetime the records was created |
error | string |
The current error for the run, if any |
filled_by_batch_type_prints | boolean |
Is this run fully filled with necessary prints or not (supported by batch_type=by_order). Can be set/changed only by further run creator |
id | string |
The identifier for this run. This identifier will be generated when the run is created and should be the name used for the print so the sytem can track it |
location | URI |
The URI of run's location (based on printer or post-processor). |
name | string |
name of a run |
notes | string |
Notes for a run |
operation | string |
Operation type of the run. Choices
'"printing|post-processing|shipping"'
|
orders | array |
List of orders URIs (based on prints). Example: '["..."]'
|
pieces_locked | boolean |
When locked, prints cannot be added to this run |
post_processor | URI |
The URI of run's post_processor. |
post_processor_type | URI |
The URI of run's post processor type. |
printer | URI |
The URI of run's printer. |
printer_type | URI |
The URI of run's printer type. |
prints | array |
The URIs of prints in the run. Example: '["..."]'
|
priority | integer |
The priority score for the run, in range 0-100, where 0 is the lowest priority and 100 is the highest priority |
run_documents | array |
none available Example: '["..."]'
|
service_provider_jobs | array |
none available Example: '["..."]'
|
shipping | URI |
The URI of run's shipping type. |
status | string |
Status of the run. Choices
'"calculating|calculated|queued|in-progress|paused|complete|error|cancelled"'
|
updated | iso-8601 datetime |
The date the run was updated. |
uri | URI |
The URI of the run. |
workstation_name | string |
The name of the printer, post processor, or shipping type |
workstation_type_name | string |
The name of the printer type or post processor type |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Run cannot consist of The system is busy printing. Please end the current process first. The requested prints do not have their associated line_items in either confirmed or printing state. The requested prints do not have same process types belonging to process steps. All the previous steps for the order should be completed before we can process these prints. |
404 |
The requested run or related object cannot be found. |
409 |
The requested status transformation is not allowed. |
/sample/
A sample represents a small negligible amount of material taken from a batch and sent off for testing. Material Test Panels are performed on samples. This endpoint controls the creation and retrieval of these samples.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the sample belongs to. |
material_batch | URI |
The URI of material_batch the sample was taken from. |
name | string |
Sample name |
source_action | URI |
The URI of material_batch_action that was used to set the material-batch to status testing. |
uri | URI |
The URI of the sample. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested sample cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the sample belongs to. Required |
material_batch | URI |
The URI of material_batch the sample was taken from. Required |
name | string |
Sample name Required |
source_action | URI |
The URI of material_batch_action that was used to set the material-batch to status testing. Required |
uri | URI |
The URI of the sample. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
404 |
The requested sample cannot be found. |
405 |
|
/sample/{uuid}/
A sample represents a small negligible amount of material taken from a batch and sent off for testing. Material Test Panels are performed on samples. This endpoint controls the creation and retrieval of these samples.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau the sample belongs to. |
material_batch | URI |
The URI of material_batch the sample was taken from. |
name | string |
Sample name |
source_action | URI |
The URI of material_batch_action that was used to set the material-batch to status testing. |
uri | URI |
The URI of the sample. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The requested sample cannot be found. |
405 |
|
/schedule_runs/
API endpoint to trigger schdule estimation. This will cause the backend to run a recursive search/scan to create a schedule starting from the selected run URI. This may change state or schedule of other Schedule.
responds to API REST GET with no UUID, to get a list of all entries. @returns tuple of (data, status_code, extra headers)
Schema (application/json)
Property | Type | Description |
---|---|---|
changed_by | URI |
URI of user changed the estimate |
estimates | object |
Estimated timing and resource usage data for this run Example: '{"time": {}, "run_type": "printing|post-processing|shipping"}'
|
run | URI |
URI of run we want to the est operation performed |
uri | URI |
URI of estimate object |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Wait until estimation process for this run will finish |
responds to API REST POST. Creates a new run_estimate from payload @returns tuple of (data, status_code, ??)
Schema (application/json)
Property | Type | Description |
---|---|---|
changed_by | URI |
URI of user changed the estimate Required |
estimates | object |
Estimated timing and resource usage data for this run Default: None Example: '{"time": {}, "run_type": "printing|post-processing|shipping"}'
|
run | URI |
URI of run we want to the est operation performed Required |
uri | URI |
URI of estimate object Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Wait until estimation process for this run will finish |
API endpoint to trigger schdule estimation. This will cause the backend to run a recursive search/scan to create a schedule starting from the selected run URI. This may change state or schedule of other Schedule.
responds to API REST GET , gets single entry from db @returns tuple of (data, status_code, ??)
Schema (application/json)
Property | Type | Description |
---|---|---|
changed_by | URI |
URI of user changed the estimate |
estimates | object |
Estimated timing and resource usage data for this run Example: '{"time": {}, "run_type": "printing|post-processing|shipping"}'
|
run | URI |
URI of run we want to the est operation performed |
uri | URI |
URI of estimate object |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Wait until estimation process for this run will finish |
/sensor-data/
This resource is dependent on the parent Sensor. This endpoint is used to list the sensor readings given the sensor. Sensor is a mandatory filter argument. Filtering by sensor will give you a list of data point under Resources. Each data point has a timestamp, humidity and temperature value. This is a READONLY endpoint. The data is fetched from Pathfindr in a background process.
Retrieve a list of sensor data points.
Returns: ResourceList: A list of sensor data points.
Raises: sepiida.errors.InvalidPayload: If sensor data listing is not supported. sepiida.errors.RecordNotFound: If the specified sensor does not exist or is inaccessible.
Schema (application/json)
Property | Type | Description |
---|---|---|
humidity | float |
Humidity value of the data point in percentage Example: '42.0'
|
sensor | URI |
URI of the sensor |
temperature | float |
Temperature value of the data point in celsius Example: '25.5'
|
timestamp | string |
Timestamp of the data point, timestamps are normally spaced by 30 mins, unless pathfindr changes their specs Example: '"2023-07-25T12:34:56Z"'
|
updated | iso-8601 datetime |
none available |
uri | URI |
URI of this sensor data point |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested sensor cannot be found. |
This resource is dependent on the parent Sensor. This endpoint is used to list the sensor readings given the sensor. Sensor is a mandatory filter argument. Filtering by sensor will give you a list of data point under Resources. Each data point has a timestamp, humidity and temperature value. This is a READONLY endpoint. The data is fetched from Pathfindr in a background process.
Schema (application/json)
Property | Type | Description |
---|---|---|
humidity | float |
Humidity value of the data point in percentage Example: '42.0'
|
sensor | URI |
URI of the sensor |
temperature | float |
Temperature value of the data point in celsius Example: '25.5'
|
timestamp | string |
Timestamp of the data point, timestamps are normally spaced by 30 mins, unless pathfindr changes their specs Example: '"2023-07-25T12:34:56Z"'
|
updated | iso-8601 datetime |
none available |
uri | URI |
URI of this sensor data point |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested sensor cannot be found. |
/sensor/
This is the resource for creating and listing sensors. This will mainly be used to create new sensor and attach them to a sublocation. This endpoint is only for creating the Sensors, the data collection happens in the backend and as a side effects updates the sensors state.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau this sensor is connected to |
frequency | integer |
frequency of data collection, in minutes |
serial_number | string |
Serial number of the sensor, cannot exceed 255 characters |
state | string |
This is the current stat of this sensor. If set to new, the sensor has been created but not yet received any data Choices
'"new|idle|error"'
|
sub_location | URI |
The URI of the sensors sub_location |
uri | URI |
URI of the sensor |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested sensor is already stored in the database The requested sensor is already attached to a sub-location
|
403 |
You are not authorized to complete the request. |
404 |
The requested sensor cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau this sensor is connected to Required |
frequency | integer |
frequency of data collection, in minutes Default: 15 |
serial_number | string |
Serial number of the sensor, cannot exceed 255 characters Required |
state | string |
This is the current stat of this sensor. If set to new, the sensor has been created but not yet received any data Default: new Choices
'"new|idle|error"'
|
sub_location | URI |
The URI of the sensors sub_location Required |
uri | URI |
URI of the sensor Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested sensor is already stored in the database The requested sensor is already attached to a sub-location
|
403 |
You are not authorized to complete the request. |
404 |
The requested sensor cannot be found. |
/sensor/{uuid}/
This is the resource for creating and listing sensors. This will mainly be used to create new sensor and attach them to a sublocation. This endpoint is only for creating the Sensors, the data collection happens in the backend and as a side effects updates the sensors state.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau this sensor is connected to |
frequency | integer |
frequency of data collection, in minutes |
serial_number | string |
Serial number of the sensor, cannot exceed 255 characters |
state | string |
This is the current stat of this sensor. If set to new, the sensor has been created but not yet received any data Choices
'"new|idle|error"'
|
sub_location | URI |
The URI of the sensors sub_location |
uri | URI |
URI of the sensor |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested sensor is already stored in the database The requested sensor is already attached to a sub-location
|
403 |
You are not authorized to complete the request. |
404 |
The requested sensor cannot be found. |
/service-provider-job/
This endpoints tracks the relationship between LineItem, and a ServiceProvider (someone that can manufacture LineItems for-hire).
A ServiceProviderJob is created first when a user decides to bid out a specific LineItem, to a specific ServiceProvider and tracks status of bid, price, production by the ServiceProvider.
Schema (application/json)
Property | Type | Description |
---|---|---|
changes_history | array |
none available Example: '["..."]'
|
cost | float |
The cost of ServiceProviderJob |
created | iso-8601 datetime |
Datetime when service provider job was requested (in UTC). |
currency | string |
Default currency (abbreviation) which is tied to cost.Bureau/service provider can change it. Required for POST + required for PUT if cost is provided. Optional for another cases Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
due_at | iso-8601 datetime |
Due at date |
job_rating | integer |
A Likert Scale (1-5) rating of the services provided. Choices
'"1|2|3|4|5"'
|
last_editor_role | string |
none available Choices
'"bureau_user|service_provider_user"'
|
line_item | URI |
The URI for line-item resource if this is line_item-level job. |
line_item_name | string |
Name of the line item. |
order | URI |
The URI of order the line-item belongs to if this is a line_item level job or order itself if this is an order-level job. |
order_line_items | array |
The uri of the line items for an order IF this is the order-level job. Example: '["..."]'
|
order_name | string |
Name of the order. |
process_step | URI |
The URI of the target process step (within line_item) if this is process_step-level job for line_item. |
provider_notes | string |
Notes left by service provider user. Regular bureau user can't edit this field - only view. |
requesting_bureau_name | string |
Name of Bureau that requested the Bid (regular bureau). |
service_provider | URI |
The URI for service-provider resource. |
shipping_tracking | string |
Shipping tracking information. |
status | string |
Status of ServiceProviderJob Choices
'"bid_requested|bid_updated|bid_negotiated|shipping_to|in_progress|shipping_from|completed|declined|cancelled"'
|
target | string |
Outsource job target; only 'line_item', 'process_step' (in the future can be added support for 'order') are valid |
updated | iso-8601 datetime |
Datetime when service provider job was updated last time (in UTC). |
uri | URI |
The URI for resource. |
workstation_name | string |
Workstation Name (based on process_step). |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Provided status transformation is not allowed The requested ServiceProviderJob name already exists. |
404 |
The requested ServiceProviderJob cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
changes_history | array |
none available Required Example: '["..."]'
|
cost | float |
The cost of ServiceProviderJob Required |
created | iso-8601 datetime |
Datetime when service provider job was requested (in UTC). Required |
currency | string |
Default currency (abbreviation) which is tied to cost.Bureau/service provider can change it. Required for POST + required for PUT if cost is provided. Optional for another cases Required Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
due_at | iso-8601 datetime |
Due at date Required |
job_rating | integer |
A Likert Scale (1-5) rating of the services provided. Required Choices
'"1|2|3|4|5"'
|
last_editor_role | string |
none available Required Choices
'"bureau_user|service_provider_user"'
|
line_item | URI |
The URI for line-item resource if this is line_item-level job. Required |
line_item_name | string |
Name of the line item. Required |
order | URI |
The URI of order the line-item belongs to if this is a line_item level job or order itself if this is an order-level job. Required |
order_line_items | array |
The uri of the line items for an order IF this is the order-level job. Required Example: '["..."]'
|
order_name | string |
Name of the order. Required |
process_step | URI |
The URI of the target process step (within line_item) if this is process_step-level job for line_item. Required |
provider_notes | string |
Notes left by service provider user. Regular bureau user can't edit this field - only view. Required |
requesting_bureau_name | string |
Name of Bureau that requested the Bid (regular bureau). Required |
service_provider | URI |
The URI for service-provider resource. Required |
shipping_tracking | string |
Shipping tracking information. Required |
status | string |
Status of ServiceProviderJob Required Choices
'"bid_requested|bid_updated|bid_negotiated|shipping_to|in_progress|shipping_from|completed|declined|cancelled"'
|
target | string |
Outsource job target; only 'line_item', 'process_step' (in the future can be added support for 'order') are valid Required |
updated | iso-8601 datetime |
Datetime when service provider job was updated last time (in UTC). Required |
uri | URI |
The URI for resource. Required |
workstation_name | string |
Workstation Name (based on process_step). Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Provided status transformation is not allowed The requested ServiceProviderJob name already exists. |
404 |
The requested ServiceProviderJob cannot be found. |
This endpoints tracks the relationship between LineItem, and a ServiceProvider (someone that can manufacture LineItems for-hire).
A ServiceProviderJob is created first when a user decides to bid out a specific LineItem, to a specific ServiceProvider and tracks status of bid, price, production by the ServiceProvider.
Schema (application/json)
Property | Type | Description |
---|---|---|
changes_history | array |
none available Example: '["..."]'
|
cost | float |
The cost of ServiceProviderJob |
created | iso-8601 datetime |
Datetime when service provider job was requested (in UTC). |
currency | string |
Default currency (abbreviation) which is tied to cost.Bureau/service provider can change it. Required for POST + required for PUT if cost is provided. Optional for another cases Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
due_at | iso-8601 datetime |
Due at date |
job_rating | integer |
A Likert Scale (1-5) rating of the services provided. Choices
'"1|2|3|4|5"'
|
last_editor_role | string |
none available Choices
'"bureau_user|service_provider_user"'
|
line_item | URI |
The URI for line-item resource if this is line_item-level job. |
line_item_name | string |
Name of the line item. |
order | URI |
The URI of order the line-item belongs to if this is a line_item level job or order itself if this is an order-level job. |
order_line_items | array |
The uri of the line items for an order IF this is the order-level job. Example: '["..."]'
|
order_name | string |
Name of the order. |
process_step | URI |
The URI of the target process step (within line_item) if this is process_step-level job for line_item. |
provider_notes | string |
Notes left by service provider user. Regular bureau user can't edit this field - only view. |
requesting_bureau_name | string |
Name of Bureau that requested the Bid (regular bureau). |
service_provider | URI |
The URI for service-provider resource. |
shipping_tracking | string |
Shipping tracking information. |
status | string |
Status of ServiceProviderJob Choices
'"bid_requested|bid_updated|bid_negotiated|shipping_to|in_progress|shipping_from|completed|declined|cancelled"'
|
target | string |
Outsource job target; only 'line_item', 'process_step' (in the future can be added support for 'order') are valid |
updated | iso-8601 datetime |
Datetime when service provider job was updated last time (in UTC). |
uri | URI |
The URI for resource. |
workstation_name | string |
Workstation Name (based on process_step). |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Provided status transformation is not allowed The requested ServiceProviderJob name already exists. |
404 |
The requested ServiceProviderJob cannot be found. |
/service-provider/
The service-provider
resource contains information about service-provider bureau's that can be
used to outsource work. All or part of an order can be handed over to service providers for fulfillment
Terms and definitions::
1. Regular bureau - common bureau.
2. Service Provider Bureau - special bureau which used only for service provider users.
3. Regular Service Provider - common service provider which can be created by regular bureau user.
4. Service Provider Hub - copied created regular service provider which will be used as bureau hub for service provider user.
When regular bureau user creates service provider we will also create one more db:service_provider
with
- source_bureau == created_service_provider.uuid
;
- group == newly_created_group.uuid
- this group will be used for granting permissions to the service provider user;
also we will create new user for this service provider and send invite to the specified email
which will allow finished
registration for this service provider user.
List all of the service-provider in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
account_status | string |
none available Choices
'"invited|active|provider_declined|rejected"'
|
address | string |
The address of the service-provider. |
bureau | URI |
The URI of the regular bureau (for bureau-based records) or of the 'Service Provider Bureau' (for SP-based records). |
custom_field_values | array |
none available Example: '[{}]'
|
string |
The email of the service-provider. |
|
group | URI |
Group which used for granting permissions for Service Provider users. For regular bureau it is NULL and unused. |
name | string |
The name of the service-provider. |
phone_number | string |
The phone number of the service-provider. |
source_bureau | URI |
The URI of the regular bureau for which was created Service Provider Hub, or NULL and unused (for regular bureau). |
source_bureau_name | string |
Name of source bureau (for sp user) and null (for regular bureau) |
source_service_provider | URI |
none available |
uri | URI |
The URI of the service-provider. |
website | string |
The website of the service-provider. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau.
|
403 |
You are not authorized to complete the request. |
404 |
The requested service provider cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
account_status | string |
none available Required Choices
'"invited|active|provider_declined|rejected"'
|
address | string |
The address of the service-provider. Default: None |
bureau | URI |
The URI of the regular bureau (for bureau-based records) or of the 'Service Provider Bureau' (for SP-based records). Required |
custom_field_values | array |
none available Default: None Example: '[{}]'
|
string |
The email of the service-provider. Required |
|
group | URI |
Group which used for granting permissions for Service Provider users. For regular bureau it is NULL and unused. Required |
name | string |
The name of the service-provider. Required |
phone_number | string |
The phone number of the service-provider. Default: None |
source_bureau | URI |
The URI of the regular bureau for which was created Service Provider Hub, or NULL and unused (for regular bureau). Required |
source_bureau_name | string |
Name of source bureau (for sp user) and null (for regular bureau) Required |
source_service_provider | URI |
none available Required |
uri | URI |
The URI of the service-provider. Default: None |
website | string |
The website of the service-provider. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau.
|
403 |
You are not authorized to complete the request. |
404 |
The requested service provider cannot be found. |
/service-provider/v1/line-item/
Returns limited information for Service Provider users about Line Items.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | object |
Info about bureau for which created line item. Example: '{}'
|
layer_thickness | float |
The layer thickness of the print in mm. Must be < 1. |
materials | object |
none available Example: '{"base": {}, "support": {}}'
|
model | object |
none available Example: '{"file_unit": "in|mm|cm|m|feet", "type": "stl"}'
|
model_unit | string |
The unit of measure for line-item's model. Choices
'"in|mm"'
|
notes | string |
Notes for a line item. |
order | URI |
The URI (for service provider API) of order the line-item belongs to. |
quantity | integer |
The number of objects to produce. |
status | string |
Status of an line-item. Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
uri | URI |
The URI of the line-item. |
workflow | object |
none available Example: '{"process_steps": ["..."]}'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | object |
Info about bureau for which created line item. Required Example: '{}'
|
layer_thickness | float |
The layer thickness of the print in mm. Must be < 1. Default: 0.2 |
materials | object |
none available Required Example: '{"base": {}, "support": {}}'
|
model | object |
none available Required Example: '{"file_unit": "in|mm|cm|m|feet", "type": "stl"}'
|
model_unit | string |
The unit of measure for line-item's model. Required Choices
'"in|mm"'
|
notes | string |
Notes for a line item. Required |
order | URI |
The URI (for service provider API) of order the line-item belongs to. Required |
quantity | integer |
The number of objects to produce. Required |
status | string |
Status of an line-item. Required Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
uri | URI |
The URI of the line-item. Required |
workflow | object |
none available Required Example: '{"process_steps": ["..."]}'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
|
404 |
|
Returns limited information for Service Provider users about Line Items.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | object |
Info about bureau for which created line item. Example: '{}'
|
layer_thickness | float |
The layer thickness of the print in mm. Must be < 1. |
materials | object |
none available Example: '{"base": {}, "support": {}}'
|
model | object |
none available Example: '{"file_unit": "in|mm|cm|m|feet", "type": "stl"}'
|
model_unit | string |
The unit of measure for line-item's model. Choices
'"in|mm"'
|
notes | string |
Notes for a line item. |
order | URI |
The URI (for service provider API) of order the line-item belongs to. |
quantity | integer |
The number of objects to produce. |
status | string |
Status of an line-item. Choices
'"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
|
uri | URI |
The URI of the line-item. |
workflow | object |
none available Example: '{"process_steps": ["..."]}'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
/service-provider/v1/order/
Returns limited information for Service Provider users about Orders.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | object |
Info about bureau for which created order. Example: '{}'
|
name | string |
Name of the order. |
owner | object |
none available Example: '{}'
|
shipping | object |
none available Example: '{}'
|
status | string |
Status of an order. Choices
'"calculating_estimates|cancelled|confirmed|complete|error|new|pending|in-preparation|processing|post-processing|printing|shipping|cloning"'
|
uri | URI |
The URI of the order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | object |
Info about bureau for which created order. Required Example: '{}'
|
name | string |
Name of the order. Required |
owner | object |
none available Required Example: '{}'
|
shipping | object |
none available Required Example: '{}'
|
status | string |
Status of an order. Required Choices
'"calculating_estimates|cancelled|confirmed|complete|error|new|pending|in-preparation|processing|post-processing|printing|shipping|cloning"'
|
uri | URI |
The URI of the order. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
|
404 |
|
Returns limited information for Service Provider users about Orders.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | object |
Info about bureau for which created order. Example: '{}'
|
name | string |
Name of the order. |
owner | object |
none available Example: '{}'
|
shipping | object |
none available Example: '{}'
|
status | string |
Status of an order. Choices
'"calculating_estimates|cancelled|confirmed|complete|error|new|pending|in-preparation|processing|post-processing|printing|shipping|cloning"'
|
uri | URI |
The URI of the order. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
The service-provider
resource contains information about service-provider bureau's that can be
used to outsource work. All or part of an order can be handed over to service providers for fulfillment
Terms and definitions::
1. Regular bureau - common bureau.
2. Service Provider Bureau - special bureau which used only for service provider users.
3. Regular Service Provider - common service provider which can be created by regular bureau user.
4. Service Provider Hub - copied created regular service provider which will be used as bureau hub for service provider user.
When regular bureau user creates service provider we will also create one more db:service_provider
with
- source_bureau == created_service_provider.uuid
;
- group == newly_created_group.uuid
- this group will be used for granting permissions to the service provider user;
also we will create new user for this service provider and send invite to the specified email
which will allow finished
registration for this service provider user.
Schema (application/json)
Property | Type | Description |
---|---|---|
account_status | string |
none available Choices
'"invited|active|provider_declined|rejected"'
|
address | string |
The address of the service-provider. |
bureau | URI |
The URI of the regular bureau (for bureau-based records) or of the 'Service Provider Bureau' (for SP-based records). |
custom_field_values | array |
none available Example: '[{}]'
|
string |
The email of the service-provider. |
|
group | URI |
Group which used for granting permissions for Service Provider users. For regular bureau it is NULL and unused. |
name | string |
The name of the service-provider. |
phone_number | string |
The phone number of the service-provider. |
source_bureau | URI |
The URI of the regular bureau for which was created Service Provider Hub, or NULL and unused (for regular bureau). |
source_bureau_name | string |
Name of source bureau (for sp user) and null (for regular bureau) |
source_service_provider | URI |
none available |
uri | URI |
The URI of the service-provider. |
website | string |
The website of the service-provider. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau.
|
403 |
You are not authorized to complete the request. |
404 |
The requested service provider cannot be found. |
/sessions/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
autologout_after | iso-8601 datetime |
Expiration time for LogonType.qr session |
contactless_secret | string |
Hashed value of the last generated user secret |
emails | array |
none available Example: '[{}]'
|
ephemeral | boolean |
none available |
impersonating | URI |
none available |
is_self_registered | boolean |
Indicates that a user created his account itself (this is not the same as membership in 'guests' group in the bureau - role in the bureau can be changed but this flag will be set up only on user creation and not available for change.) |
logon_type | string |
The method to be used to login Choices
'"password|qr"'
|
name | string |
none available |
password | string |
none available |
submit | string |
none available |
tos | boolean |
none available |
uri | URI |
none available |
username | string |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Inititate a new user-session to our API. This will validate the use, and send them back a bearer-token (session key) so they don't have to send log-in data over and over in payload (risky). Not there is some special case code here for qr-kiosk mode, etc.
Schema (application/json)
Property | Type | Description |
---|---|---|
autologout_after | iso-8601 datetime |
Expiration time for LogonType.qr session Required |
contactless_secret | string |
Hashed value of the last generated user secret Required |
emails | array |
none available Default: [] Example: '[{}]'
|
ephemeral | boolean |
none available Default: False |
impersonating | URI |
none available Default: None |
is_self_registered | boolean |
Indicates that a user created his account itself (this is not the same as membership in 'guests' group in the bureau - role in the bureau can be changed but this flag will be set up only on user creation and not available for change.) Default: False |
logon_type | string |
The method to be used to login Required Choices
'"password|qr"'
|
name | string |
none available Default: None |
password | string |
none available Required |
submit | string |
none available Default: None |
tos | boolean |
none available Default: False |
uri | URI |
none available Default: None |
username | string |
none available Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
autologout_after | iso-8601 datetime |
Expiration time for LogonType.qr session |
contactless_secret | string |
Hashed value of the last generated user secret |
emails | array |
none available Example: '[{}]'
|
ephemeral | boolean |
none available |
impersonating | URI |
none available |
is_self_registered | boolean |
Indicates that a user created his account itself (this is not the same as membership in 'guests' group in the bureau - role in the bureau can be changed but this flag will be set up only on user creation and not available for change.) |
logon_type | string |
The method to be used to login Choices
'"password|qr"'
|
name | string |
none available |
password | string |
none available |
submit | string |
none available |
tos | boolean |
none available |
uri | URI |
none available |
username | string |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/shipment-packing-slip/
An ShipmentPackingSlip
is a docx file listing what needs to be shipped in an order.
It may include all or some limited group of Line Items in the Order it is related to.
Packing slip may need to be regenerated at a new date.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | URL |
the download link for the packing slip document. |
created | iso-8601 datetime |
The date the packing slip was created. |
order | URI |
The order to get an packing slip document on. |
run | URI |
Shipment Run associated with shipment at the time of creation. |
shipment | URI |
The shipment to get an packing slip document on. |
status | string |
none available Choices
'"pending|processing|complete|error"'
|
updated | iso-8601 datetime |
The date the packing slip was last time updated.. |
uri | URI |
The URI of the packing slip. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested shipment packing slip or related order cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
content | URL |
the download link for the packing slip document. Required |
created | iso-8601 datetime |
The date the packing slip was created. Required |
order | URI |
The order to get an packing slip document on. Required |
run | URI |
Shipment Run associated with shipment at the time of creation. Required |
shipment | URI |
The shipment to get an packing slip document on. Required |
status | string |
none available Required Choices
'"pending|processing|complete|error"'
|
updated | iso-8601 datetime |
The date the packing slip was last time updated.. Required |
uri | URI |
The URI of the packing slip. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested shipment packing slip or related order cannot be found. |
An ShipmentPackingSlip
is a docx file listing what needs to be shipped in an order.
It may include all or some limited group of Line Items in the Order it is related to.
Packing slip may need to be regenerated at a new date.
Schema (application/json)
Property | Type | Description |
---|---|---|
content | URL |
the download link for the packing slip document. |
created | iso-8601 datetime |
The date the packing slip was created. |
order | URI |
The order to get an packing slip document on. |
run | URI |
Shipment Run associated with shipment at the time of creation. |
shipment | URI |
The shipment to get an packing slip document on. |
status | string |
none available Choices
'"pending|processing|complete|error"'
|
updated | iso-8601 datetime |
The date the packing slip was last time updated.. |
uri | URI |
The URI of the packing slip. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested shipment packing slip or related order cannot be found. |
/shipment/
Shipment is the resource for tracking packages moving by a shipping company. Do not confuse with 'shipping' which is a kind of workstation/step in a workflow. For "service-provider-on-steps" feature, tied only to run. For "shipment-for-order" feature, tied always to "order" and for "run" (when it will be created).
Schema (application/json)
Property | Type | Description |
---|---|---|
actual_cost | float |
Actual cost |
actual_delivery_date | iso-8601 datetime |
Actual delivery date |
actual_shipment_date | iso-8601 datetime |
Actual shipment date |
billing_address | object |
Billing to this address. All fields must be submitted on update (even with null values) Example: '{}'
|
created | iso-8601 datetime |
Datetime when process provider was requested (in UTC). |
currency | string |
Currency for the costs fields. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
duration | timedelta |
The length of time it will take to complete shipment in seconds. |
estimated_cost | float |
Always null. Estimated cost |
estimated_delivery_date | iso-8601 datetime |
Estimated delivery date. Set by run scheduler |
estimated_shipment_date | iso-8601 datetime |
Estimated shipment date. Set by run scheduler |
name | string |
Shipment name |
order | URI |
Related order with this shipment. For Service Providers shipments is always null. For shipment-by-order feature is always set. |
origin_address | object |
Shipping from this address. All fields must be submitted on update (even with null values) Example: '{}'
|
recipient_address | object |
Shipping to this address. All fields must be submitted on update (even with null values) Example: '{}'
|
run | URI |
Related run. For Service Providers shipments run always exists. For shipment-by-order this field is null if run does not exist, but will be filled in when related run is created. |
shipper_url | URL |
Shipper URI |
shipping_partner | string |
Shipping Partner (USPS, DHL, etc) |
status | string |
Shipment status Choices
'"new|queued|in_transit|received|error|cancelled"'
|
tracking_number | string |
Delivery address |
updated | iso-8601 datetime |
Datetime when process provider was updated last time (in UTC). |
uri | URI |
The URI for process provider. |
user | URI |
The URI of the user created the shipment. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
The requested Shipment (or related record) cannot be found. |
We don't allow to create shipment via rest (for now). Record should be created when run is created
Schema (application/json)
Property | Type | Description |
---|---|---|
actual_cost | float |
Actual cost Required |
actual_delivery_date | iso-8601 datetime |
Actual delivery date Required |
actual_shipment_date | iso-8601 datetime |
Actual shipment date Required |
billing_address | object |
Billing to this address. All fields must be submitted on update (even with null values) Required Example: '{}'
|
created | iso-8601 datetime |
Datetime when process provider was requested (in UTC). Required |
currency | string |
Currency for the costs fields. Required Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
duration | timedelta |
The length of time it will take to complete shipment in seconds. Required |
estimated_cost | float |
Always null. Estimated cost Required |
estimated_delivery_date | iso-8601 datetime |
Estimated delivery date. Set by run scheduler Required |
estimated_shipment_date | iso-8601 datetime |
Estimated shipment date. Set by run scheduler Required |
name | string |
Shipment name Required |
order | URI |
Related order with this shipment. For Service Providers shipments is always null. For shipment-by-order feature is always set. Required |
origin_address | object |
Shipping from this address. All fields must be submitted on update (even with null values) Required Example: '{}'
|
recipient_address | object |
Shipping to this address. All fields must be submitted on update (even with null values) Required Example: '{}'
|
run | URI |
Related run. For Service Providers shipments run always exists. For shipment-by-order this field is null if run does not exist, but will be filled in when related run is created. Required |
shipper_url | URL |
Shipper URI Default: None |
shipping_partner | string |
Shipping Partner (USPS, DHL, etc) Required |
status | string |
Shipment status Required Choices
'"new|queued|in_transit|received|error|cancelled"'
|
tracking_number | string |
Delivery address Required |
updated | iso-8601 datetime |
Datetime when process provider was updated last time (in UTC). Required |
uri | URI |
The URI for process provider. Required |
user | URI |
The URI of the user created the shipment. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
404 |
The requested Shipment (or related record) cannot be found. |
Shipment is the resource for tracking packages moving by a shipping company. Do not confuse with 'shipping' which is a kind of workstation/step in a workflow. For "service-provider-on-steps" feature, tied only to run. For "shipment-for-order" feature, tied always to "order" and for "run" (when it will be created).
Schema (application/json)
Property | Type | Description |
---|---|---|
actual_cost | float |
Actual cost |
actual_delivery_date | iso-8601 datetime |
Actual delivery date |
actual_shipment_date | iso-8601 datetime |
Actual shipment date |
billing_address | object |
Billing to this address. All fields must be submitted on update (even with null values) Example: '{}'
|
created | iso-8601 datetime |
Datetime when process provider was requested (in UTC). |
currency | string |
Currency for the costs fields. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
duration | timedelta |
The length of time it will take to complete shipment in seconds. |
estimated_cost | float |
Always null. Estimated cost |
estimated_delivery_date | iso-8601 datetime |
Estimated delivery date. Set by run scheduler |
estimated_shipment_date | iso-8601 datetime |
Estimated shipment date. Set by run scheduler |
name | string |
Shipment name |
order | URI |
Related order with this shipment. For Service Providers shipments is always null. For shipment-by-order feature is always set. |
origin_address | object |
Shipping from this address. All fields must be submitted on update (even with null values) Example: '{}'
|
recipient_address | object |
Shipping to this address. All fields must be submitted on update (even with null values) Example: '{}'
|
run | URI |
Related run. For Service Providers shipments run always exists. For shipment-by-order this field is null if run does not exist, but will be filled in when related run is created. |
shipper_url | URL |
Shipper URI |
shipping_partner | string |
Shipping Partner (USPS, DHL, etc) |
status | string |
Shipment status Choices
'"new|queued|in_transit|received|error|cancelled"'
|
tracking_number | string |
Delivery address |
updated | iso-8601 datetime |
Datetime when process provider was updated last time (in UTC). |
uri | URI |
The URI for process provider. |
user | URI |
The URI of the user created the shipment. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
The requested Shipment (or related record) cannot be found. |
/shipping/
Shipping endpoint has all the available shipping resource for a bureau and region.
List all of the shipping in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
batching_strategy | string |
Batching Strategy which describe how should be grouped Prints for Run with this Shipping. Choices
'"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single|by_job"'
|
build_volume | object |
Dimensions of the build volume in millimeters. Used when Example: '{}'
|
bureau | URI |
The URI of the bureau for which we have the shipping value. |
cost | float |
The unit cost of shipping. |
description | string |
The name of the shipping. Example: '"Standard Shipping"'
|
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
in_progress | array |
Realtime updated list of runs in_progress at the shipping station. Due to query complexity, GET only. Example: '["..."]'
|
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the shipping station. Read only |
min_packing_distance | float |
Min distance between Parts. Used when |
name | string |
The description of the shipping. Example: '"Standard fixed cost shipping"'
|
number_of_parts | integer |
Max number of Prints in Run. Used when |
region | string |
Select a region from the list: ['africa', 'antarctica', 'asia', 'australia', 'europe', 'north-america', 'south-america'] Choices
'"africa|antarctica|asia|australia|europe|north-america|south-america"'
|
uri | URI |
The URI for shipping resource. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau. The requested shipping name for the region already exists.
Cannot delete shipping that has runs in queue. Remove runs before deleting shipping. |
403 |
You are not authorized to complete the request.
|
404 |
The requested shipping cannot be found. |
Create a new shipping resource.
Schema (application/json)
Property | Type | Description |
---|---|---|
batching_strategy | string |
Batching Strategy which describe how should be grouped Prints for Run with this Shipping. Default: single Choices
'"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single|by_job"'
|
build_volume | object |
Dimensions of the build volume in millimeters. Used when Required Example: '{}'
|
bureau | URI |
The URI of the bureau for which we have the shipping value. Required |
cost | float |
The unit cost of shipping. Required |
description | string |
The name of the shipping. Required Example: '"Standard Shipping"'
|
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. Required |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. Required |
in_progress | array |
Realtime updated list of runs in_progress at the shipping station. Due to query complexity, GET only. Required Example: '["..."]'
|
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the shipping station. Read only Required |
min_packing_distance | float |
Min distance between Parts. Used when Default: None |
name | string |
The description of the shipping. Required Example: '"Standard fixed cost shipping"'
|
number_of_parts | integer |
Max number of Prints in Run. Used when Default: None |
region | string |
Select a region from the list: ['africa', 'antarctica', 'asia', 'australia', 'europe', 'north-america', 'south-america'] Required Choices
'"africa|antarctica|asia|australia|europe|north-america|south-america"'
|
uri | URI |
The URI for shipping resource. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau. The requested shipping name for the region already exists.
Cannot delete shipping that has runs in queue. Remove runs before deleting shipping. |
403 |
You are not authorized to complete the request.
|
404 |
The requested shipping cannot be found. |
Shipping endpoint has all the available shipping resource for a bureau and region.
Get an individual shipping resource by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
batching_strategy | string |
Batching Strategy which describe how should be grouped Prints for Run with this Shipping. Choices
'"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single|by_job"'
|
build_volume | object |
Dimensions of the build volume in millimeters. Used when Example: '{}'
|
bureau | URI |
The URI of the bureau for which we have the shipping value. |
cost | float |
The unit cost of shipping. |
description | string |
The name of the shipping. Example: '"Standard Shipping"'
|
flow_time | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has ended work. At this workstation (or workstation-type). Rounded longer to 4 hour blocks. |
flow_time_queued | timedelta |
Historic Mean time from 'Piece can be worked on' to 'Piece has started work' At this workstation (or workstation-type).Rounded longer to 4 hour blocks. |
in_progress | array |
Realtime updated list of runs in_progress at the shipping station. Due to query complexity, GET only. Example: '["..."]'
|
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the shipping station. Read only |
min_packing_distance | float |
Min distance between Parts. Used when |
name | string |
The description of the shipping. Example: '"Standard fixed cost shipping"'
|
number_of_parts | integer |
Max number of Prints in Run. Used when |
region | string |
Select a region from the list: ['africa', 'antarctica', 'asia', 'australia', 'europe', 'north-america', 'south-america'] Choices
'"africa|antarctica|asia|australia|europe|north-america|south-america"'
|
uri | URI |
The URI for shipping resource. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau. The requested shipping name for the region already exists.
Cannot delete shipping that has runs in queue. Remove runs before deleting shipping. |
403 |
You are not authorized to complete the request.
|
404 |
The requested shipping cannot be found. |
/shopping-cart-item/
ShoppingCartItem are the individual items, with their corresponding quantities, to convert to line-items when the shopping cart is checked out. (status->complete). Initially source will be model_library objects and destination will be line-items. This may be expanded in the future to support multiple source/destinations.
Schema (application/json)
Property | Type | Description |
---|---|---|
destination | URI |
The URI of the line-item object created after checking out this shopping cart item. May be expanded inthe future |
material_override | URI |
This is an optional override that is set when the shopping_cart_item's material differs from the related model-library. |
price_per | float |
This is the cost being presented to the user in the shopping-cart per quantity of this item. Before checkout this is 1-1 auto-updated from 'source' object . After checkout it will be frozen, no longer update from 'source; object. None if source has no known price_per |
quantity | integer |
represents how many instances of the model-library needed to fullfill the order. Maps directly to the resulting line-item quantity. |
shopping_cart | URI |
The URI of the shopping-cart this item belongs to. |
source | URI |
The URI of the model-library object which will be used as a template to create the line-items at checkout(submit). |
uri | URI |
The URI of this shopping-cart-item. Model-library plus quantity to be converted to a line-item at checkout. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
The requested shopping-cart-item cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
destination | URI |
The URI of the line-item object created after checking out this shopping cart item. May be expanded inthe future Required |
material_override | URI |
This is an optional override that is set when the shopping_cart_item's material differs from the related model-library. Required |
price_per | float |
This is the cost being presented to the user in the shopping-cart per quantity of this item. Before checkout this is 1-1 auto-updated from 'source' object . After checkout it will be frozen, no longer update from 'source; object. None if source has no known price_per Required |
quantity | integer |
represents how many instances of the model-library needed to fullfill the order. Maps directly to the resulting line-item quantity. Required |
shopping_cart | URI |
The URI of the shopping-cart this item belongs to. Required |
source | URI |
The URI of the model-library object which will be used as a template to create the line-items at checkout(submit). Required |
uri | URI |
The URI of this shopping-cart-item. Model-library plus quantity to be converted to a line-item at checkout. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
404 |
The requested shopping-cart-item cannot be found. |
ShoppingCartItem are the individual items, with their corresponding quantities, to convert to line-items when the shopping cart is checked out. (status->complete). Initially source will be model_library objects and destination will be line-items. This may be expanded in the future to support multiple source/destinations.
Schema (application/json)
Property | Type | Description |
---|---|---|
destination | URI |
The URI of the line-item object created after checking out this shopping cart item. May be expanded inthe future |
material_override | URI |
This is an optional override that is set when the shopping_cart_item's material differs from the related model-library. |
price_per | float |
This is the cost being presented to the user in the shopping-cart per quantity of this item. Before checkout this is 1-1 auto-updated from 'source' object . After checkout it will be frozen, no longer update from 'source; object. None if source has no known price_per |
quantity | integer |
represents how many instances of the model-library needed to fullfill the order. Maps directly to the resulting line-item quantity. |
shopping_cart | URI |
The URI of the shopping-cart this item belongs to. |
source | URI |
The URI of the model-library object which will be used as a template to create the line-items at checkout(submit). |
uri | URI |
The URI of this shopping-cart-item. Model-library plus quantity to be converted to a line-item at checkout. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
The requested shopping-cart-item cannot be found. |
/shopping-cart/
A shopping cart allows users to select multiple model_library objects in digital design warehouse by adding to their carts. When they are ready to checkout they can convert their shopping cart into an order and line-items etc. Every user can have exactly one active (empty, in-progress) shopping cart at a time.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau this shopping cart belongs to. |
name | string |
The name of the shopping-cart. To be converted into the order name at checkout. |
order | URI |
Read Only: When a shopping-cart status is updated to |
owner | URI |
URI identifying the owner of this shopping cart. One Owner per shopping cart with no sharing between users. |
payment_status | string |
none available Choices
'"new|ready|pending|complete|abandoned|error"'
|
status | string |
the current state of the shopping cart. ex: (empty, in-progress, complete, abandoned) Choices
'"empty|in-progress|complete|abandoned"'
|
uri | URI |
The URI of the shopping-cart. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Invalid payload. |
404 |
The requested shopping_cart cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau this shopping cart belongs to. Required |
name | string |
The name of the shopping-cart. To be converted into the order name at checkout. Default: Unnamed Shopping Cart |
order | URI |
Read Only: When a shopping-cart status is updated to Required |
owner | URI |
URI identifying the owner of this shopping cart. One Owner per shopping cart with no sharing between users. Required |
payment_status | string |
none available Required Choices
'"new|ready|pending|complete|abandoned|error"'
|
status | string |
the current state of the shopping cart. ex: (empty, in-progress, complete, abandoned) Required Choices
'"empty|in-progress|complete|abandoned"'
|
uri | URI |
The URI of the shopping-cart. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
Invalid payload. |
404 |
The requested shopping_cart cannot be found. |
405 |
|
A shopping cart allows users to select multiple model_library objects in digital design warehouse by adding to their carts. When they are ready to checkout they can convert their shopping cart into an order and line-items etc. Every user can have exactly one active (empty, in-progress) shopping cart at a time.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The URI of bureau this shopping cart belongs to. |
name | string |
The name of the shopping-cart. To be converted into the order name at checkout. |
order | URI |
Read Only: When a shopping-cart status is updated to |
owner | URI |
URI identifying the owner of this shopping cart. One Owner per shopping cart with no sharing between users. |
payment_status | string |
none available Choices
'"new|ready|pending|complete|abandoned|error"'
|
status | string |
the current state of the shopping cart. ex: (empty, in-progress, complete, abandoned) Choices
'"empty|in-progress|complete|abandoned"'
|
uri | URI |
The URI of the shopping-cart. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
Invalid payload. |
404 |
The requested shopping_cart cannot be found. |
405 |
|
/slice/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
callback | object |
none available Example: '{"method": "POST|PUT|GET"}'
|
config | URI |
none available |
content | string |
none available |
error | string |
none available |
estimated_slicing_time_ms | integer |
none available |
estimates | object |
none available Example: '{}'
|
model | URI |
none available |
slice_time | string |
none available |
status | string |
none available |
uri | URI |
none available |
use_vision | boolean |
none available |
user | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
generated-exception-class raised
|
Schema (application/json)
Property | Type | Description |
---|---|---|
callback | object |
none available Default: None Example: '{"method": "POST|PUT|GET"}'
|
config | URI |
none available Required |
content | string |
none available Default: None |
error | string |
none available Default: None |
estimated_slicing_time_ms | integer |
none available Default: None |
estimates | object |
none available Default: None Example: '{}'
|
model | URI |
none available Required |
slice_time | string |
none available Default: None |
status | string |
none available Default: None |
uri | URI |
none available Default: None |
use_vision | boolean |
none available Default: False |
user | URI |
none available Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
generated-exception-class raised
|
/slice/{uuid}/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
callback | object |
none available Example: '{"method": "POST|PUT|GET"}'
|
config | URI |
none available |
content | string |
none available |
error | string |
none available |
estimated_slicing_time_ms | integer |
none available |
estimates | object |
none available Example: '{}'
|
model | URI |
none available |
slice_time | string |
none available |
status | string |
none available |
uri | URI |
none available |
use_vision | boolean |
none available |
user | URI |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
generated-exception-class raised
|
/specimen/
Specimen data is stored as part of the Model Library, but has a unique API Endpoint to make it easier for developers to use.
An engineering specimen can be tied to model and a workflow. In other words tables.ModelLibrary & model_library.type == 'specimen') can be linked to a parent tables.workflow.
During a print-run creations, if the selected workflow has a specimen linked to it, extra work will be done to calculate the minimum set of specimens need to be added.
The specimen models will be automatically added to a print-volume, and the workflow process the engineering specimen will automatically be added to the rest of the process-steps in the workflow.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date when the Specimen was created. |
model_library | URI |
The URI of the Model Library |
parent_workflow | URI |
The URI of parent workflow. |
quantity | integer |
The number of Specimens to produce. |
updated | iso-8601 datetime |
The date when the Specimen was updated |
uri | URI |
The Specimen URI. |
workflow | URI |
The URI of workflow which describes the process steps that should be performed with this specimen (except for the printing step - it should be taken from the parent_workflow). |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date when the Specimen was created. Default: None |
model_library | URI |
The URI of the Model Library Required |
parent_workflow | URI |
The URI of parent workflow. Default: None |
quantity | integer |
The number of Specimens to produce. Default: 1 |
updated | iso-8601 datetime |
The date when the Specimen was updated Default: None |
uri | URI |
The Specimen URI. Required |
workflow | URI |
The URI of workflow which describes the process steps that should be performed with this specimen (except for the printing step - it should be taken from the parent_workflow). Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
|
404 |
|
Specimen data is stored as part of the Model Library, but has a unique API Endpoint to make it easier for developers to use.
An engineering specimen can be tied to model and a workflow. In other words tables.ModelLibrary & model_library.type == 'specimen') can be linked to a parent tables.workflow.
During a print-run creations, if the selected workflow has a specimen linked to it, extra work will be done to calculate the minimum set of specimens need to be added.
The specimen models will be automatically added to a print-volume, and the workflow process the engineering specimen will automatically be added to the rest of the process-steps in the workflow.
Schema (application/json)
Property | Type | Description |
---|---|---|
created | iso-8601 datetime |
The date when the Specimen was created. |
model_library | URI |
The URI of the Model Library |
parent_workflow | URI |
The URI of parent workflow. |
quantity | integer |
The number of Specimens to produce. |
updated | iso-8601 datetime |
The date when the Specimen was updated |
uri | URI |
The Specimen URI. |
workflow | URI |
The URI of workflow which describes the process steps that should be performed with this specimen (except for the printing step - it should be taken from the parent_workflow). |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
/stock-summary/sub-location//stock/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
batches_quantity_available | float |
The amount of material available for use in material_batches, that belong to this sub_location, stock |
material_lot_quantity_available | float |
The quantity of material available, in material_lots, that relate to this sub_location and stock |
material_lot_quantity_on_order | float |
The quantity of material on order, in material_lots, that relate to this sub_location and stock |
stock | URI |
The stock the summary was performed on. Represents the material on hand at a manufacturing facility. |
sub_location | URI |
The uri of the sub_location. Which is a subset of manufacturing facility(clean room, lab, etc) |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
batches_quantity_available | float |
The amount of material available for use in material_batches, that belong to this sub_location, stock Required |
material_lot_quantity_available | float |
The quantity of material available, in material_lots, that relate to this sub_location and stock Required |
material_lot_quantity_on_order | float |
The quantity of material on order, in material_lots, that relate to this sub_location and stock Required |
stock | URI |
The stock the summary was performed on. Represents the material on hand at a manufacturing facility. Required |
sub_location | URI |
The uri of the sub_location. Which is a subset of manufacturing facility(clean room, lab, etc) Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
batches_quantity_available | float |
The amount of material available for use in material_batches, that belong to this sub_location, stock |
material_lot_quantity_available | float |
The quantity of material available, in material_lots, that relate to this sub_location and stock |
material_lot_quantity_on_order | float |
The quantity of material on order, in material_lots, that relate to this sub_location and stock |
stock | URI |
The stock the summary was performed on. Represents the material on hand at a manufacturing facility. |
sub_location | URI |
The uri of the sub_location. Which is a subset of manufacturing facility(clean room, lab, etc) |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/stock/
Stock works with the /material/ and /location/ endpoints to identify what materials are available on-hand for an organization. As orders are processed and prints are performed the stock will be consumed and should be replenished. By automatically tracking stock the ERP module makes it easier to avoid costly downtime due to out-of-stock issues and to produce reports on stock expiration, rotation and profitability
List all of the stocks in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
location | URI |
The URI of the stock's location. |
material | URI |
The URI of the stock's material. |
material_batches | array |
The array of URIs of material batches Example: '["..."]'
|
material_lots | array |
The array of URIs of material lots Example: '["..."]'
|
modeler | URI |
The URI of the stock's modeler. |
on_order_quantity | float |
Quantity of stock that has been ordered but not yet arrived. Used in email triggers to reduce false positives to order new materials This field is read-only if the 'material-management' feature enabled (and will be calculated based on material containers in material lot from the same 'location + material'). |
quantity | float |
The stock's quantity. This field is read-only if the 'material-management' feature enabled (and will be calculated based on material containers in material lots from the same 'location + material'). |
status | string |
Status of the stock. Choices
'"in-use|available|exhausted"'
|
stock_max | float |
Target max stock level for re-order. Stock available quantity can exceed this level. In units of related material. |
stock_min | float |
Target min stock level for re-order. Triggers an email when stock available quantity goes below this level. In units of related material. |
track_quantity | boolean |
When True, we track stock quantity, on_order_quantity, and min/max fields on a stock. False is used to make a material available at a location, without tracking quantities. |
uri | URI |
The URI of the stock. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
A stock with requested material and location already exists (this pair should be unique). |
403 |
You are not authorized to complete the request. |
404 |
The requested stock cannot be found. |
Create a new stock.
Schema (application/json)
Property | Type | Description |
---|---|---|
location | URI |
The URI of the stock's location. Required |
material | URI |
The URI of the stock's material. Required |
material_batches | array |
The array of URIs of material batches Required Example: '["..."]'
|
material_lots | array |
The array of URIs of material lots Required Example: '["..."]'
|
modeler | URI |
The URI of the stock's modeler. Default: None |
on_order_quantity | float |
Quantity of stock that has been ordered but not yet arrived. Used in email triggers to reduce false positives to order new materials This field is read-only if the 'material-management' feature enabled (and will be calculated based on material containers in material lot from the same 'location + material'). Default: None |
quantity | float |
The stock's quantity. This field is read-only if the 'material-management' feature enabled (and will be calculated based on material containers in material lots from the same 'location + material'). Default: 0 |
status | string |
Status of the stock. Default: available Choices
'"in-use|available|exhausted"'
|
stock_max | float |
Target max stock level for re-order. Stock available quantity can exceed this level. In units of related material. Default: None |
stock_min | float |
Target min stock level for re-order. Triggers an email when stock available quantity goes below this level. In units of related material. Default: None |
track_quantity | boolean |
When True, we track stock quantity, on_order_quantity, and min/max fields on a stock. False is used to make a material available at a location, without tracking quantities. Default: True |
uri | URI |
The URI of the stock. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
A stock with requested material and location already exists (this pair should be unique). |
403 |
You are not authorized to complete the request. |
404 |
The requested stock cannot be found. |
/stock/{uuid}/
Stock works with the /material/ and /location/ endpoints to identify what materials are available on-hand for an organization. As orders are processed and prints are performed the stock will be consumed and should be replenished. By automatically tracking stock the ERP module makes it easier to avoid costly downtime due to out-of-stock issues and to produce reports on stock expiration, rotation and profitability
Get a single stock by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
location | URI |
The URI of the stock's location. |
material | URI |
The URI of the stock's material. |
material_batches | array |
The array of URIs of material batches Example: '["..."]'
|
material_lots | array |
The array of URIs of material lots Example: '["..."]'
|
modeler | URI |
The URI of the stock's modeler. |
on_order_quantity | float |
Quantity of stock that has been ordered but not yet arrived. Used in email triggers to reduce false positives to order new materials This field is read-only if the 'material-management' feature enabled (and will be calculated based on material containers in material lot from the same 'location + material'). |
quantity | float |
The stock's quantity. This field is read-only if the 'material-management' feature enabled (and will be calculated based on material containers in material lots from the same 'location + material'). |
status | string |
Status of the stock. Choices
'"in-use|available|exhausted"'
|
stock_max | float |
Target max stock level for re-order. Stock available quantity can exceed this level. In units of related material. |
stock_min | float |
Target min stock level for re-order. Triggers an email when stock available quantity goes below this level. In units of related material. |
track_quantity | boolean |
When True, we track stock quantity, on_order_quantity, and min/max fields on a stock. False is used to make a material available at a location, without tracking quantities. |
uri | URI |
The URI of the stock. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
A stock with requested material and location already exists (this pair should be unique). |
403 |
You are not authorized to complete the request. |
404 |
The requested stock cannot be found. |
/stripe-event-listener/
This endpoint is to be called only by teh stripe webhook. This endpoint will only support post method and will validate Signature of incoming calls to make sure it's coming from stripe and stripe only.
Schema (application/json)
Property | Type | Description |
---|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Processes incoming HTTP(S) event stream Check stripe events docs here: https://stripe.com/docs/api/events
Schema (application/json)
Property | Type | Description |
---|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This endpoint is to be called only by teh stripe webhook. This endpoint will only support post method and will validate Signature of incoming calls to make sure it's coming from stripe and stripe only.
Schema (application/json)
Property | Type | Description |
---|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/sub-location/
A sub-division of a given MFG Location. Commonly a physically defined, specific area within a MFG Location that may be monitored using Environmental Sensors. They may also be a procedurally driven / “abstract” sub-division of a Location to allow for the grouping/segregation of Resources within a MFG Location.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The datetime when sub-location was marked as archived. |
bureau | URI |
The URI of the bureau. |
description | string |
The description for the sub-location |
is_default | boolean |
True if the default sub-location for the given location. False otherwise. There must be one default sub-location for every location. |
location | URI |
The URI of the location this sub-location belongs to. |
name | string |
The name of the sub-location. |
uri | URI |
The URI of the sub-location resource |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The datetime when sub-location was marked as archived. Required |
bureau | URI |
The URI of the bureau. Required |
description | string |
The description for the sub-location Required |
is_default | boolean |
True if the default sub-location for the given location. False otherwise. There must be one default sub-location for every location. Required |
location | URI |
The URI of the location this sub-location belongs to. Default: None |
name | string |
The name of the sub-location. Required |
uri | URI |
The URI of the sub-location resource Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
A sub-division of a given MFG Location. Commonly a physically defined, specific area within a MFG Location that may be monitored using Environmental Sensors. They may also be a procedurally driven / “abstract” sub-division of a Location to allow for the grouping/segregation of Resources within a MFG Location.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
The datetime when sub-location was marked as archived. |
bureau | URI |
The URI of the bureau. |
description | string |
The description for the sub-location |
is_default | boolean |
True if the default sub-location for the given location. False otherwise. There must be one default sub-location for every location. |
location | URI |
The URI of the location this sub-location belongs to. |
name | string |
The name of the sub-location. |
uri | URI |
The URI of the sub-location resource |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Get the data about all Support Strategy
Schema (application/json)
Property | Type | Description |
---|---|---|
name | string |
The name of the support strategy. Choices
'"n|a|m|e"'
|
uri | URI |
The URI of the support strategy. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
RecordNotFound raised |
Get the data about all Support Strategy
Schema (application/json)
Property | Type | Description |
---|---|---|
name | string |
The name of the support strategy. Choices
'"n|a|m|e"'
|
uri | URI |
The URI of the support strategy. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
RecordNotFound raised |
/time-entry/
Endpoint for time entries, created by user or system.
List all time entries.
Schema (application/json)
Property | Type | Description |
---|---|---|
category | string |
Time entry category. Choices
'"attending|machine-running|in-progress|on-hold"'
|
completed_by | URI |
The URI of the user that completed this time entry. |
created | iso-8601 datetime |
The date this time entry was created. |
created_by | URI |
The URI of the user that created this time entry. |
end_time | iso-8601 datetime |
The date and time the time entry is completed |
notes | string |
Notes for a time entry. |
related_table_name | string |
Related table name of entry. Choices
'"run|prep_task_record"'
|
related_uuid | uuid |
Related uuid of entry. |
start_time | iso-8601 datetime |
The date and time when time entry started |
updated | iso-8601 datetime |
The date this time entry was updated. |
uri | URI |
The URI of the time entry record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested time entry cannot be found. |
Create a new time entry.
Schema (application/json)
Property | Type | Description |
---|---|---|
category | string |
Time entry category. Required Choices
'"attending|machine-running|in-progress|on-hold"'
|
completed_by | URI |
The URI of the user that completed this time entry. Default: None |
created | iso-8601 datetime |
The date this time entry was created. Default: None |
created_by | URI |
The URI of the user that created this time entry. Required |
end_time | iso-8601 datetime |
The date and time the time entry is completed Required |
notes | string |
Notes for a time entry. Default: None |
related_table_name | string |
Related table name of entry. Required Choices
'"run|prep_task_record"'
|
related_uuid | uuid |
Related uuid of entry. Required |
start_time | iso-8601 datetime |
The date and time when time entry started Required |
updated | iso-8601 datetime |
The date this time entry was updated. Default: None |
uri | URI |
The URI of the time entry record. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested time entry cannot be found. |
Endpoint for time entries, created by user or system.
Get an time entry by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
category | string |
Time entry category. Choices
'"attending|machine-running|in-progress|on-hold"'
|
completed_by | URI |
The URI of the user that completed this time entry. |
created | iso-8601 datetime |
The date this time entry was created. |
created_by | URI |
The URI of the user that created this time entry. |
end_time | iso-8601 datetime |
The date and time the time entry is completed |
notes | string |
Notes for a time entry. |
related_table_name | string |
Related table name of entry. Choices
'"run|prep_task_record"'
|
related_uuid | uuid |
Related uuid of entry. |
start_time | iso-8601 datetime |
The date and time when time entry started |
updated | iso-8601 datetime |
The date this time entry was updated. |
uri | URI |
The URI of the time entry record. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested time entry cannot be found. |
/traceability-report/
The traceability report api is for exporting the events that transpired during the creation of a given object as a printable document.
List all of the traceability reports in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. |
content | URL |
the download link for the document |
created | iso-8601 datetime |
The date the report was created. |
filters | array |
Limit report data to specific operation group Example: '["cad_model_changes|cad_model_replaced|print_events|post_process_events|work_checklist_changes|manual_notes|other|work_instruction_report|preparation_events"]'
|
piece | URI |
The Piece to get a report on. |
status | string |
Status of a report. Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the report. |
user | URI |
The URI of the user making the report. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested report cannot be found. |
Request to generate a new traceability report.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. Default: None |
content | URL |
the download link for the document Default: None |
created | iso-8601 datetime |
The date the report was created. Default: None |
filters | array |
Limit report data to specific operation group Required Example: '["cad_model_changes|cad_model_replaced|print_events|post_process_events|work_checklist_changes|manual_notes|other|work_instruction_report|preparation_events"]'
|
piece | URI |
The Piece to get a report on. Required |
status | string |
Status of a report. Default: None Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the report. Default: None |
user | URI |
The URI of the user making the report. Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested report cannot be found. |
The traceability report api is for exporting the events that transpired during the creation of a given object as a printable document.
Get a single traceability report by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
The bureau a report belongs to. |
content | URL |
the download link for the document |
created | iso-8601 datetime |
The date the report was created. |
filters | array |
Limit report data to specific operation group Example: '["cad_model_changes|cad_model_replaced|print_events|post_process_events|work_checklist_changes|manual_notes|other|work_instruction_report|preparation_events"]'
|
piece | URI |
The Piece to get a report on. |
status | string |
Status of a report. Choices
'"pending|processing|complete|error"'
|
uri | URI |
The URI of the report. |
user | URI |
The URI of the user making the report. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
403 |
You are not authorized to complete the request. |
404 |
The requested report cannot be found. |
/traveler/
The traveler api is for exporting the details of an Order along with the model associated with it as a printable document.
Schema (application/json)
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/users/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
address | string |
none available |
archived | boolean |
none available |
bureau | URI |
Bureau URI for the bureau we are adding the user to. No funny business. POST will default to POST-ersbureau if not set. |
company | string |
none available |
contactless_enabled | boolean |
If contactless_secret is not None for user then return True Choices
'"True|False"'
|
context | object |
Read-only. Fields that are bureau (or integration) specific, non-standard data on a specific user.Per bureau use or behaivor may change Example: 'null'
|
string |
Canonical, final email address of this user. Issue a support request to chage |
|
emails | array |
none available Example: '["..."]'
|
enable_contactless_logon | boolean |
False will invalidate any existing contactless logon, True is passed with no effect |
get_contactless_logon | boolean |
True will regenerate any existing contactless logon, invalidating previous qr code, and return new qr_logon_code,False is passed with no effect |
group | URI |
none available |
is_self_registered | boolean |
Indicates that a user created his account itself (this is not the same as membership in 'guests' group in the bureau - role in the bureau can be changed but this flag will be set up only on user creation and not available for change.) |
login | boolean |
none available |
name | string |
none available |
password | string |
none available |
qr_logon_code | string |
base64 representation of QR logon |
submit | string |
none available |
tos | boolean |
none available |
uri | URI |
The URI for this user |
username | string |
Canonical, final username of this user. Issue a support request to chage |
uuid | uuid |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
503 |
|
Add a user, let API select/generate URI/UUID if it's a new user Must be POST via a 'inviter' valid HTTPS connection from a user of the same bureau
Schema (application/json)
Property | Type | Description |
---|---|---|
address | string |
none available Default: None |
archived | boolean |
none available Default: False |
bureau | URI |
Bureau URI for the bureau we are adding the user to. No funny business. POST will default to POST-ersbureau if not set. Default: None |
company | string |
none available Default: None |
contactless_enabled | boolean |
If contactless_secret is not None for user then return True Default: False Choices
'"True|False"'
|
context | object |
Read-only. Fields that are bureau (or integration) specific, non-standard data on a specific user.Per bureau use or behaivor may change Required Example: 'null'
|
string |
Canonical, final email address of this user. Issue a support request to chage Default: None |
|
emails | array |
none available Default: [] Example: '["..."]'
|
enable_contactless_logon | boolean |
False will invalidate any existing contactless logon, True is passed with no effect Default: None |
get_contactless_logon | boolean |
True will regenerate any existing contactless logon, invalidating previous qr code, and return new qr_logon_code,False is passed with no effect Default: None |
group | URI |
none available Default: None |
is_self_registered | boolean |
Indicates that a user created his account itself (this is not the same as membership in 'guests' group in the bureau - role in the bureau can be changed but this flag will be set up only on user creation and not available for change.) Default: False |
login | boolean |
none available Default: True |
name | string |
none available Default: None |
password | string |
none available Default: None |
qr_logon_code | string |
base64 representation of QR logon Default: None |
submit | string |
none available Default: None |
tos | boolean |
none available Default: False |
uri | URI |
The URI for this user Default: None |
username | string |
Canonical, final username of this user. Issue a support request to chage Default: None |
uuid | uuid |
none available Default: None |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
503 |
|
/users/{uuid}/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
address | string |
none available |
archived | boolean |
none available |
bureau | URI |
Bureau URI for the bureau we are adding the user to. No funny business. POST will default to POST-ersbureau if not set. |
company | string |
none available |
contactless_enabled | boolean |
If contactless_secret is not None for user then return True Choices
'"True|False"'
|
context | object |
Read-only. Fields that are bureau (or integration) specific, non-standard data on a specific user.Per bureau use or behaivor may change Example: 'null'
|
string |
Canonical, final email address of this user. Issue a support request to chage |
|
emails | array |
none available Example: '["..."]'
|
enable_contactless_logon | boolean |
False will invalidate any existing contactless logon, True is passed with no effect |
get_contactless_logon | boolean |
True will regenerate any existing contactless logon, invalidating previous qr code, and return new qr_logon_code,False is passed with no effect |
group | URI |
none available |
is_self_registered | boolean |
Indicates that a user created his account itself (this is not the same as membership in 'guests' group in the bureau - role in the bureau can be changed but this flag will be set up only on user creation and not available for change.) |
login | boolean |
none available |
name | string |
none available |
password | string |
none available |
qr_logon_code | string |
base64 representation of QR logon |
submit | string |
none available |
tos | boolean |
none available |
uri | URI |
The URI for this user |
username | string |
Canonical, final username of this user. Issue a support request to chage |
uuid | uuid |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
503 |
|
Endpoint for generating csv/json/etc reports for /analytics page.
Schema (application/json)
Property | Type | Description |
---|---|---|
end_time | iso-8601 datetime |
The date and time the build ended, if available |
file_format | string |
Format of report, that will be generated (csv, json, etc.). Choices
'"csv|json"'
|
start_time | iso-8601 datetime |
The date and time the build started |
template | string |
Template of report, that will be generated Choices
'"analytics_of_state|analytics_of_yield|operating_time_days|operating_time_weeks"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/volume/
This endpoint allows you to get information about volume successfully printed
Schema (application/json)
Property | Type | Description |
---|---|---|
build_name | string |
The name of the build as determined by the printer |
end_time | iso-8601 datetime |
The date and time the build ended, if available |
failed_builds | integer |
The count of failed builds |
max_end_time | iso-8601 datetime |
The max date and time the build ended |
min_start_time | iso-8601 datetime |
The min date and time the build started |
modeler_name | string |
The name of the printer performing the build |
new_builds | integer |
The count of new builds |
part_count | integer |
The count of parts in the build |
processing_builds | integer |
The count of processing builds |
start_time | iso-8601 datetime |
The date and time the build started |
successful_builds | integer |
The count of successful builds |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
404 |
The build requested cannot be found |
A checklist can be attached to many types of things in the system:: printer_type, post_processor_type, process_step, or even print objects.
This endpoint is for a quickly finding the right checklist for something based on the object and type (GET/LIST).
Checklist can 'inherit' from parent types (for example, a print 'process_step' may inherit from it's printer_type) this handle that logic as well.
Each step is in a work_instruction
object. Log of checking-off things marked as done are stored
in a related work_instruction_report
.
Schema (application/json)
Property | Type | Description |
---|---|---|
position | integer |
Step position for the Line Item's Work Checklist |
process_step | URI |
The URI of the process step. |
related_uri | URL |
URI for one of next tables: [printer type, post_processor_type, shipping, line_item, print]. |
uri | URI |
Individual self-link, mostly for list functions |
work_checklist | object |
none available Example: ('{"work_instructions": [{"choices": ["..."], "required": "True|False", '
'"report_type": "checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location", '
'"report_units": "mm|cm|inch|gram|kg|lb", "threshold": null, '
'"threshold_type": '
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to", '
'"threshold_action": "warning|error|warning_prompt_ncr", '
'"threshold_notification": "piece_owner|user_group"}]}')
|
work_checklist_uri | URI |
Filter-only field for filtering work checklists by URI. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
A checklist can be attached to many types of things in the system:: printer_type, post_processor_type, process_step, or even print objects.
This endpoint is for a quickly finding the right checklist for something based on the object and type (GET/LIST).
Checklist can 'inherit' from parent types (for example, a print 'process_step' may inherit from it's printer_type) this handle that logic as well.
Each step is in a work_instruction
object. Log of checking-off things marked as done are stored
in a related work_instruction_report
.
Schema (application/json)
Property | Type | Description |
---|---|---|
position | integer |
Step position for the Line Item's Work Checklist |
process_step | URI |
The URI of the process step. |
related_uri | URL |
URI for one of next tables: [printer type, post_processor_type, shipping, line_item, print]. |
uri | URI |
Individual self-link, mostly for list functions |
work_checklist | object |
none available Example: ('{"work_instructions": [{"choices": ["..."], "required": "True|False", '
'"report_type": "checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location", '
'"report_units": "mm|cm|inch|gram|kg|lb", "threshold": null, '
'"threshold_type": '
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to", '
'"threshold_action": "warning|error|warning_prompt_ncr", '
'"threshold_notification": "piece_owner|user_group"}]}')
|
work_checklist_uri | URI |
Filter-only field for filtering work checklists by URI. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
/work-checklist/
This endpoint is for viewing a checklist of task to do during a work step.
See work_checklist_linking
to see what the each checklist is attached to. Checklist instance can be attached to many other types.
Each step is in a work_instruction
object. Log of checking-off things marked as done are stored
in a related work_instruction_report
.
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_instruction_url | URL |
URL for the external video, image or some document which provides additional extended instructions for the work checklist |
bureau | URI |
Bureau of the Work Checklist. |
created | iso-8601 datetime |
none available |
description | string |
Description for the Work Checklist. |
initial_related_uri | URL |
Work checklists are inherited. This is the URI for the root of inheritance.One of: [printer_type, post_processor_type, shipping, line_item, print]. |
name | string |
Title of the Work Checklist. |
updated | iso-8601 datetime |
none available |
updated_by | URI |
Who update/create Work Checklist. |
uri | URI |
The Work Checklist URI. If URI not provided - then work checklist doesn't exists yet and should be built/created (if method PUT) or will be used as template (if we return it via GET or LIST with API |
version | integer |
Count of Work Checklist updated. |
work_instructions | array |
Optional List of Work Instructions for the Line Item's Work Checklist. Example: ('[{"choices": ["..."], "required": "True|False", "report_type": '
'"checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location", '
'"report_units": "mm|cm|inch|gram|kg|lb", "threshold": null, '
'"threshold_type": '
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to", '
'"threshold_action": "warning|error|warning_prompt_ncr", '
'"threshold_notification": "piece_owner|user_group"}]')
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
This endpoint is for viewing a checklist of task to do during a work step.
See work_checklist_linking
to see what the each checklist is attached to. Checklist instance can be attached to many other types.
Each step is in a work_instruction
object. Log of checking-off things marked as done are stored
in a related work_instruction_report
.
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_instruction_url | URL |
URL for the external video, image or some document which provides additional extended instructions for the work checklist |
bureau | URI |
Bureau of the Work Checklist. |
created | iso-8601 datetime |
none available |
description | string |
Description for the Work Checklist. |
initial_related_uri | URL |
Work checklists are inherited. This is the URI for the root of inheritance.One of: [printer_type, post_processor_type, shipping, line_item, print]. |
name | string |
Title of the Work Checklist. |
updated | iso-8601 datetime |
none available |
updated_by | URI |
Who update/create Work Checklist. |
uri | URI |
The Work Checklist URI. If URI not provided - then work checklist doesn't exists yet and should be built/created (if method PUT) or will be used as template (if we return it via GET or LIST with API |
version | integer |
Count of Work Checklist updated. |
work_instructions | array |
Optional List of Work Instructions for the Line Item's Work Checklist. Example: ('[{"choices": ["..."], "required": "True|False", "report_type": '
'"checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location", '
'"report_units": "mm|cm|inch|gram|kg|lb", "threshold": null, '
'"threshold_type": '
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to", '
'"threshold_action": "warning|error|warning_prompt_ncr", '
'"threshold_notification": "piece_owner|user_group"}]')
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
|
404 |
|
A Work Checklist can be specified for many types of things in the system:: printer_type, post_processor_type, shipping, process_steps of a workflow, line-item, or even print objects.
In a lot of those case, use is inherited, AKA if there is no 'print' work checklist, the system scans for a 'process-step' checklist, if no process-step checklist, it scans for a workstation_type checklist, and so on.
This API for getting work checklist linkings (with work checklist) for specific resource, via looking it up in the inheritance tree. See work-checklist-for for setting work-checklist for some resource.
Return work checklists linkings (with work_checklists with work_instructions)
by filter related_uri
; this filter is required for this API.
Schema (application/json)
Property | Type | Description |
---|---|---|
related_uri | URL |
URI of the related resource. Resource can be one of: print, printer_type, post_processor_type, shipping, line_item, piece, workflow. |
work_checklist_linkings | array |
Work checklists linkings (with work checklists with work instructions) for a related_uri. It can be linking directly created for the related resource or inherited linkings. Example: ('[{"work_checklist": {"work_instructions": [{"choices": ["..."], "required": '
'"True|False", "report_type": "checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location", '
'"report_units": "mm|cm|inch|gram|kg|lb", "threshold": null, '
'"threshold_type": '
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to", '
'"threshold_action": "warning|error|warning_prompt_ncr", '
'"threshold_notification": "piece_owner|user_group"}]}}]')
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
One of the provided objects doesn't exists. |
A checklist can be attached to many types of things in the system:: printer_type, post_processor_type, process_step, line-item or even print objects.
This API is used for creating, updating and deleting work checklists for specific objects via PUT method.
/work-instruction-report-action/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
action_type | string |
The action type Choices
'"create"'
|
created | iso-8601 datetime |
The date the work_instruction_report_action was created. |
metadata | array |
Action specific JSON blob for action metadata. See METADATA_SIGNATURES for more details. Example: '["..."]'
|
notes | string |
Custom user description/notes for this action. |
status | string |
The status Choices
'"pending|processing|complete|error"'
|
uri | URI |
Work Instruction Report Action's URI. |
user | URI |
A user whom performed an action |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
action_type | string |
The action type Required Choices
'"create"'
|
created | iso-8601 datetime |
The date the work_instruction_report_action was created. Required |
metadata | array |
Action specific JSON blob for action metadata. See METADATA_SIGNATURES for more details. Default: [] Example: '["..."]'
|
notes | string |
Custom user description/notes for this action. Required |
status | string |
The status Required Choices
'"pending|processing|complete|error"'
|
uri | URI |
Work Instruction Report Action's URI. Required |
user | URI |
A user whom performed an action Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
404 |
|
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
action_type | string |
The action type Choices
'"create"'
|
created | iso-8601 datetime |
The date the work_instruction_report_action was created. |
metadata | array |
Action specific JSON blob for action metadata. See METADATA_SIGNATURES for more details. Example: '["..."]'
|
notes | string |
Custom user description/notes for this action. |
status | string |
The status Choices
'"pending|processing|complete|error"'
|
uri | URI |
Work Instruction Report Action's URI. |
user | URI |
A user whom performed an action |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
|
/work-instruction-report-summary/
This endpoint is used to generate a summary of work_instruction and work_instruction_report data for each print that has a work_instruction_report created for it. It gathers data about each work_instruction (and related report) in a work_checklist for each print associated with a report. Currently, we support filtering this endpoint by a piece uri or a work_checklist uri Usage Examples: /work-instruction-report-summary/?filter[piece]=some_piece_uri /work-instruction-report-summary/?filter[work_checklist]=some_work checklist_uri We also support filtering reports that were submitted within a certain date range Usage Example: /work-instruction-report-summary/?filter[completed]%3E2021-08-01T15:06:04.317030&filter[completed]%3C2021-09-01T15:06:04.317030
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau of the Work Instruction Report. |
completed | iso-8601 datetime |
Datetime filter-only field to fetch work-instruction-reports by when they were completed. |
order | URI |
Order that the report is linked to |
piece | URI |
Piece that the report is linked to |
piece_name | string |
Piece name that report is linked to |
URI |
Print that the report is linked to. |
|
run | URI |
Run that the report is linked to |
run_name | string |
Run name that the report is linked to |
work_checklist | URI |
Work checklist related to the work_instruction |
work_checklist_name | string |
Name of the work_checklist |
work_instructions_summary | array |
List of Work Instruction and Work Instruction report data . Example: ('[{"choices": ["..."], "required": "True|False", "report_type": '
'"checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location", '
'"report_units": "mm|cm|inch|gram|kg|lb", "threshold": null, '
'"threshold_type": '
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to", '
'"threshold_action": "warning|error|warning_prompt_ncr", '
'"threshold_notification": "piece_owner|user_group"}]')
|
workflow | URI |
Workflow that the report is linked to |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau of the Work Instruction Report. Required |
completed | iso-8601 datetime |
Datetime filter-only field to fetch work-instruction-reports by when they were completed. Required |
order | URI |
Order that the report is linked to Required |
piece | URI |
Piece that the report is linked to Required |
piece_name | string |
Piece name that report is linked to Required |
URI |
Print that the report is linked to. Required |
|
run | URI |
Run that the report is linked to Required |
run_name | string |
Run name that the report is linked to Required |
work_checklist | URI |
Work checklist related to the work_instruction Required |
work_checklist_name | string |
Name of the work_checklist Required |
work_instructions_summary | array |
List of Work Instruction and Work Instruction report data . Required Example: ('[{"choices": ["..."], "required": "True|False", "report_type": '
'"checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location", '
'"report_units": "mm|cm|inch|gram|kg|lb", "threshold": null, '
'"threshold_type": '
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to", '
'"threshold_action": "warning|error|warning_prompt_ncr", '
'"threshold_notification": "piece_owner|user_group"}]')
|
workflow | URI |
Workflow that the report is linked to Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
This endpoint is used to generate a summary of work_instruction and work_instruction_report data for each print that has a work_instruction_report created for it. It gathers data about each work_instruction (and related report) in a work_checklist for each print associated with a report. Currently, we support filtering this endpoint by a piece uri or a work_checklist uri Usage Examples: /work-instruction-report-summary/?filter[piece]=some_piece_uri /work-instruction-report-summary/?filter[work_checklist]=some_work checklist_uri We also support filtering reports that were submitted within a certain date range Usage Example: /work-instruction-report-summary/?filter[completed]%3E2021-08-01T15:06:04.317030&filter[completed]%3C2021-09-01T15:06:04.317030
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau of the Work Instruction Report. |
completed | iso-8601 datetime |
Datetime filter-only field to fetch work-instruction-reports by when they were completed. |
order | URI |
Order that the report is linked to |
piece | URI |
Piece that the report is linked to |
piece_name | string |
Piece name that report is linked to |
URI |
Print that the report is linked to. |
|
run | URI |
Run that the report is linked to |
run_name | string |
Run name that the report is linked to |
work_checklist | URI |
Work checklist related to the work_instruction |
work_checklist_name | string |
Name of the work_checklist |
work_instructions_summary | array |
List of Work Instruction and Work Instruction report data . Example: ('[{"choices": ["..."], "required": "True|False", "report_type": '
'"checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location", '
'"report_units": "mm|cm|inch|gram|kg|lb", "threshold": null, '
'"threshold_type": '
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to", '
'"threshold_action": "warning|error|warning_prompt_ncr", '
'"threshold_notification": "piece_owner|user_group"}]')
|
workflow | URI |
Workflow that the report is linked to |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/work-instruction-report/
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau of the Work Instruction Report. |
completed | iso-8601 datetime |
Date, when instruction was done. |
outside_threshold | boolean |
Is threshold of checklist exceeded or not. |
URI |
The Print to get a report on. |
|
report | string |
Content of the report, if provided |
report_file | object |
none available Example: '{}'
|
user | URI |
User that created report. |
work_instruction | uuid |
The UUID of the work-instruction. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau of the Work Instruction Report. Required |
completed | iso-8601 datetime |
Date, when instruction was done. Default: None |
outside_threshold | boolean |
Is threshold of checklist exceeded or not. Required |
URI |
The Print to get a report on. Required |
|
report | string |
Content of the report, if provided Required |
report_file | object |
none available Required Example: '{}'
|
user | URI |
User that created report. Required |
work_instruction | uuid |
The UUID of the work-instruction. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
|
404 |
|
This is a basic API endpoint wrapper, to extend a Flask View with extra features.
Schema (application/json)
Property | Type | Description |
---|---|---|
bureau | URI |
Bureau of the Work Instruction Report. |
completed | iso-8601 datetime |
Date, when instruction was done. |
outside_threshold | boolean |
Is threshold of checklist exceeded or not. |
URI |
The Print to get a report on. |
|
report | string |
Content of the report, if provided |
report_file | object |
none available Example: '{}'
|
user | URI |
User that created report. |
work_instruction | uuid |
The UUID of the work-instruction. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
|
404 |
|
/work-instruction/
NOTE: this is only for 'floating' / 'template' work instructions. Any other work instructions need to be GET / SET / PUT / POST via work_checklist
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_instruction_url | URL |
URL for the external video, image or some document which provides additional extended instructions for the Work Instruction |
choices | array |
none available Example: '["..."]'
|
description | string |
Descriptions for the step. |
position | integer |
Step position of the Work Instruction for the Line Item's Work Checklist |
report_type | string |
In which format should be passed report for this instruction. Choices
('"checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location"')
|
report_units | string |
In which units should be passed report for this instruction. Choices
'"mm|cm|inch|gram|kg|lb"'
|
required | boolean |
Is report for this instruction required or not. Choices
'"True|False"'
|
threshold | object |
Threshold as a JSON blob based on 'threshold_type'. See THRESHOLD_SIGNATURES for more details. Example: 'null'
|
threshold_action | string |
An error level, which describes how to validate threshold values. See enum info for more details. Choices
'"warning|error|warning_prompt_ncr"'
|
threshold_notification | string |
When a reported value is past threshold, send email notices to whom? Choices
'"piece_owner|user_group"'
|
threshold_type | string |
Type of the Threshold value. Threshold signature is based on this field. Choices
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to"'
|
uuid | uuid |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_instruction_url | URL |
URL for the external video, image or some document which provides additional extended instructions for the Work Instruction Required |
choices | array |
none available Required Example: '["..."]'
|
description | string |
Descriptions for the step. Required |
position | integer |
Step position of the Work Instruction for the Line Item's Work Checklist Required |
report_type | string |
In which format should be passed report for this instruction. Default: text Choices
('"checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location"')
|
report_units | string |
In which units should be passed report for this instruction. Default: None Choices
'"mm|cm|inch|gram|kg|lb"'
|
required | boolean |
Is report for this instruction required or not. Default: False Choices
'"True|False"'
|
threshold | object |
Threshold as a JSON blob based on 'threshold_type'. See THRESHOLD_SIGNATURES for more details. Default: None Example: 'null'
|
threshold_action | string |
An error level, which describes how to validate threshold values. See enum info for more details. Default: None Choices
'"warning|error|warning_prompt_ncr"'
|
threshold_notification | string |
When a reported value is past threshold, send email notices to whom? Default: None Choices
'"piece_owner|user_group"'
|
threshold_type | string |
Type of the Threshold value. Threshold signature is based on this field. Default: None Choices
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to"'
|
uuid | uuid |
none available Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
NOTE: this is only for 'floating' / 'template' work instructions. Any other work instructions need to be GET / SET / PUT / POST via work_checklist
Schema (application/json)
Property | Type | Description |
---|---|---|
additional_instruction_url | URL |
URL for the external video, image or some document which provides additional extended instructions for the Work Instruction |
choices | array |
none available Example: '["..."]'
|
description | string |
Descriptions for the step. |
position | integer |
Step position of the Work Instruction for the Line Item's Work Checklist |
report_type | string |
In which format should be passed report for this instruction. Choices
('"checkbox|document|picture|no '
'entry|number|range|text|single-selection-dropdown|output-at-location"')
|
report_units | string |
In which units should be passed report for this instruction. Choices
'"mm|cm|inch|gram|kg|lb"'
|
required | boolean |
Is report for this instruction required or not. Choices
'"True|False"'
|
threshold | object |
Threshold as a JSON blob based on 'threshold_type'. See THRESHOLD_SIGNATURES for more details. Example: 'null'
|
threshold_action | string |
An error level, which describes how to validate threshold values. See enum info for more details. Choices
'"warning|error|warning_prompt_ncr"'
|
threshold_notification | string |
When a reported value is past threshold, send email notices to whom? Choices
'"piece_owner|user_group"'
|
threshold_type | string |
Type of the Threshold value. Threshold signature is based on this field. Choices
'"between|not-between|tolerance|less-than|less-than-or-equals-to|greater-than|greater-than-or-equals-to|contains|not-contains|equals-to|not-equals-to"'
|
uuid | uuid |
none available |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/work-schedule/
Defines the work schedule for a resource. This attaches to workstation_type only now. may attach to more in the future. Used to indicate clock time / week-calendar time when a process is 'workable' AKA people or machines can run.
Args: nautilus (type): description
Schema (application/json)
Property | Type | Description |
---|---|---|
post_processor_type | URI |
The URI of post processor type this schedule applies to. |
printer_type | URI |
The URI of printer type this schedule applies to. |
type | string |
Type of Labor timing. 24/7 available, or per week-calendar below. if non-stop values below are ignored. Choices
'"non_stop|calendar"'
|
uri | URI |
The URI of the work-schedule record. |
utc_offset | float |
Float representation of hours offset from UTC of the timezone for target workstation or workstation types. Default to Zero |
week | object |
none available Example: ('{"monday": {"start": {}, "finish": {}}, "tuesday": {"start": {}, "finish": '
'{}}, "wednesday": {"start": {}, "finish": {}}, "thursday": {"start": {}, '
'"finish": {}}, "friday": {"start": {}, "finish": {}}, "saturday": {"start": '
'{}, "finish": {}}, "sunday": {"start": {}, "finish": {}}}')
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested post_processor_type is already attached to a work-schedule. |
403 |
You are not authorized to complete the request. |
404 |
The requested work schedule cannot be found. |
405 |
|
Schema (application/json)
Property | Type | Description |
---|---|---|
post_processor_type | URI |
The URI of post processor type this schedule applies to. Required |
printer_type | URI |
The URI of printer type this schedule applies to. Required |
type | string |
Type of Labor timing. 24/7 available, or per week-calendar below. if non-stop values below are ignored. Required Choices
'"non_stop|calendar"'
|
uri | URI |
The URI of the work-schedule record. Required |
utc_offset | float |
Float representation of hours offset from UTC of the timezone for target workstation or workstation types. Default to Zero Default: 0 |
week | object |
none available Default: {} Example: ('{"monday": {"start": {}, "finish": {}}, "tuesday": {"start": {}, "finish": '
'{}}, "wednesday": {"start": {}, "finish": {}}, "thursday": {"start": {}, '
'"finish": {}}, "friday": {"start": {}, "finish": {}}, "saturday": {"start": '
'{}, "finish": {}}, "sunday": {"start": {}, "finish": {}}}')
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested post_processor_type is already attached to a work-schedule. |
403 |
You are not authorized to complete the request. |
404 |
The requested work schedule cannot be found. |
405 |
|
Defines the work schedule for a resource. This attaches to workstation_type only now. may attach to more in the future. Used to indicate clock time / week-calendar time when a process is 'workable' AKA people or machines can run.
Args: nautilus (type): description
Schema (application/json)
Property | Type | Description |
---|---|---|
post_processor_type | URI |
The URI of post processor type this schedule applies to. |
printer_type | URI |
The URI of printer type this schedule applies to. |
type | string |
Type of Labor timing. 24/7 available, or per week-calendar below. if non-stop values below are ignored. Choices
'"non_stop|calendar"'
|
uri | URI |
The URI of the work-schedule record. |
utc_offset | float |
Float representation of hours offset from UTC of the timezone for target workstation or workstation types. Default to Zero |
week | object |
none available Example: ('{"monday": {"start": {}, "finish": {}}, "tuesday": {"start": {}, "finish": '
'{}}, "wednesday": {"start": {}, "finish": {}}, "thursday": {"start": {}, '
'"finish": {}}, "friday": {"start": {}, "finish": {}}, "saturday": {"start": '
'{}, "finish": {}}, "sunday": {"start": {}, "finish": {}}}')
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The requested post_processor_type is already attached to a work-schedule. |
403 |
You are not authorized to complete the request. |
404 |
The requested work schedule cannot be found. |
405 |
|
/workflow/
A workflow defines a process to be followed to manufacture a part. The workflow is just that, a workflow. Individual orders can be customized to follow a different process for just that order.
The workflow identifies the printer type to be used and any post-processing steps that should occur after a print. The workflow may also contain a shipping strategy to be used to ship the parts to a customer.
Workflows are composed of some metadata and a sequence of process-steps
that are identified by the
process_steps
property. Ordering of this property is important
List all of the workflow in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the workflow. Example: '"First version of workflow."'
|
flow_time | timedelta |
Summation of the flow_time values from each process_step in the workflow |
flow_time_queued | timedelta |
Summation of the flow_time_queued values from each process_step in the workflow |
include_custom_workflows | boolean |
Indicates should be included custom workflows line items/pieces or not. |
line_item | URI |
URI of a line item to which workflow is pinned. It means that workflow was created and can be used only for this line item. |
materials | array |
URIs of a material to which this workflow is pinned. Example: '["..."]'
|
name | string |
The name of the workflow. Example: '"Workflow-0.1"'
|
pieces | array |
URIs of a pieces to which this workflow is pinned. It means that workflow was created by 'change workflow' run transformation and can be user only by these pieces. Example: '["..."]'
|
process_steps | array |
The uri of the process steps for this workflow. Example: '["..."]'
|
source_workflow | URI |
URI of a workflow based on which current workflow was cloned/duplicated. |
specimens | array |
Optional List of specimens (dict with 'URI and quantity') for Workflow with Example: '[{}]'
|
type | string |
Choices
'"additive_manufacturing|specimen|powder_manufacturing"'
|
updated | iso-8601 datetime |
The date the workflow was updated. |
updated_by | URI |
The user that last updated the workflow. |
uri | URI |
The URI for workflow resource. |
usage_state | string |
Representing workflow's usage state based on usage by db:line_item table.'archived' state can be passed into PUT signature to archive workflow (if it allowed by workflow usage_state). Choices
'"archived|active|can_be_safely_archived|inactive"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau. The requested workflow name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested workflow cannot be found. |
409 |
The requested workflow is attached to line items that are processing. |
Create a new workflow resource.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the workflow. Default: None Example: '"First version of workflow."'
|
flow_time | timedelta |
Summation of the flow_time values from each process_step in the workflow Required |
flow_time_queued | timedelta |
Summation of the flow_time_queued values from each process_step in the workflow Required |
include_custom_workflows | boolean |
Indicates should be included custom workflows line items/pieces or not. Required |
line_item | URI |
URI of a line item to which workflow is pinned. It means that workflow was created and can be used only for this line item. Required |
materials | array |
URIs of a material to which this workflow is pinned. Required Example: '["..."]'
|
name | string |
The name of the workflow. Required Example: '"Workflow-0.1"'
|
pieces | array |
URIs of a pieces to which this workflow is pinned. It means that workflow was created by 'change workflow' run transformation and can be user only by these pieces. Required Example: '["..."]'
|
process_steps | array |
The uri of the process steps for this workflow. Default: None Example: '["..."]'
|
source_workflow | URI |
URI of a workflow based on which current workflow was cloned/duplicated. Required |
specimens | array |
Optional List of specimens (dict with 'URI and quantity') for Workflow with Default: None Example: '[{}]'
|
type | string |
Default: additive_manufacturing Choices
'"additive_manufacturing|specimen|powder_manufacturing"'
|
updated | iso-8601 datetime |
The date the workflow was updated. Required |
updated_by | URI |
The user that last updated the workflow. Required |
uri | URI |
The URI for workflow resource. Required |
usage_state | string |
Representing workflow's usage state based on usage by db:line_item table.'archived' state can be passed into PUT signature to archive workflow (if it allowed by workflow usage_state). Required Choices
'"archived|active|can_be_safely_archived|inactive"'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau. The requested workflow name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested workflow cannot be found. |
409 |
The requested workflow is attached to line items that are processing. |
/workflow//replace/
Action endpoint (POST / GET/ LIST only) to replace a workflow on an active line-item. If needed, this may also do a copy and 'pin' workflow into line item level.
Due line-items or related workflows, business logic blocks "POST" to 'workflow' or 'line-item'
I. For line_item level workflow we do next steps (line_item is not None)::
- checking permissions by fetching source_workflow
and line_item;
- maybe updating name for new workflow to avoid constraint error;
- building payload and creating new workflow with permission on it;
- updating line_item with new workflow: it automatically, if needed (if process steps were changed), will recreate prints;
- re-creating work_checklist_linkings based on line_item or source_workflow
work_checklists (if exist);
- replace process_steps with replaced one (based on process_step.source_process_step) for service-provider-job
.
- re-creating specimens based on source_workflow
, if they exist.
II. Next cases available for common workflows (line_item is None
)
1. Common steps::
- checking permissions by fetching source_workflow
;
- Checking workflow usage_state - this operation available only for active
workflows;
- updating source_workflow
name to avoid constraint error and mark it as archived
(with utc_now datetime);
- building payload and creating new workflow with permission on it;
- re-creating work_checklist_linkings based on source_workflow
work_checklists (if exist);
2. For `additive_manufacturing` workflow we do next additional steps::
- re-creating specimens based on ``source_workflow``, if they exist;
- updating model_libraries which using ``source_workflow`` with new workflow uuid;
- updating bureau_settings.default_workflow - if it using ``source_workflow``;
- updating line_items which have statuses <= 'pending' with new workflow (it will trigger re-creating prints).
3. For `specimen` workflow we do only next additional step::
- updating existing specimens which using ``source_workflow``.
Replaces source_workflow with newly created workflow
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the workflow. Required Example: '"First version of workflow."'
|
line_item | URI |
URI of a line item to which workflow is pinned. It means that workflow will be createdand can be used only for this line item. Required |
name | string |
The name of the new workflow. Required Example: '"Workflow-0.1"'
|
process_steps | array |
The uri of the process steps for this workflow. Process steps should be already created by frontend via API /process-step/ Required Example: '["..."]'
|
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
400 |
The requested workflow name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested workflow cannot be found. |
409 |
The requested workflow is attached to line items that are processing. |
A workflow defines a process to be followed to manufacture a part. The workflow is just that, a workflow. Individual orders can be customized to follow a different process for just that order.
The workflow identifies the printer type to be used and any post-processing steps that should occur after a print. The workflow may also contain a shipping strategy to be used to ship the parts to a customer.
Workflows are composed of some metadata and a sequence of process-steps
that are identified by the
process_steps
property. Ordering of this property is important
Get an individual workflow resource by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
description | string |
The description of the workflow. Example: '"First version of workflow."'
|
flow_time | timedelta |
Summation of the flow_time values from each process_step in the workflow |
flow_time_queued | timedelta |
Summation of the flow_time_queued values from each process_step in the workflow |
include_custom_workflows | boolean |
Indicates should be included custom workflows line items/pieces or not. |
line_item | URI |
URI of a line item to which workflow is pinned. It means that workflow was created and can be used only for this line item. |
materials | array |
URIs of a material to which this workflow is pinned. Example: '["..."]'
|
name | string |
The name of the workflow. Example: '"Workflow-0.1"'
|
pieces | array |
URIs of a pieces to which this workflow is pinned. It means that workflow was created by 'change workflow' run transformation and can be user only by these pieces. Example: '["..."]'
|
process_steps | array |
The uri of the process steps for this workflow. Example: '["..."]'
|
source_workflow | URI |
URI of a workflow based on which current workflow was cloned/duplicated. |
specimens | array |
Optional List of specimens (dict with 'URI and quantity') for Workflow with Example: '[{}]'
|
type | string |
Choices
'"additive_manufacturing|specimen|powder_manufacturing"'
|
updated | iso-8601 datetime |
The date the workflow was updated. |
updated_by | URI |
The user that last updated the workflow. |
uri | URI |
The URI for workflow resource. |
usage_state | string |
Representing workflow's usage state based on usage by db:line_item table.'archived' state can be passed into PUT signature to archive workflow (if it allowed by workflow usage_state). Choices
'"archived|active|can_be_safely_archived|inactive"'
|
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
400 |
The value of bureau appears to be an invalid bureau. The requested workflow name already exists. |
403 |
You are not authorized to complete the request. |
404 |
The requested workflow cannot be found. |
409 |
The requested workflow is attached to line items that are processing. |
/workstation/
A Workstation is a physical location where a specific kind of work is done. Currently a Read-Only collection/Summary of Workstation types (printer/post-processor/shipping) that are stored in their own tables.
Workstation Printer:
Workstation Post-Processor:
Workstation Shipping:
NOTE: As of 2022-10-03 Workstation logic is mostly split into 'printer'/'post-processor'/'shipping' right now. This is the start of refactoring to a single workstation behavior is
List all of the workstations in the system for your account.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
If archived, the datetime the post-processor was archived. |
description | string |
Description of printer |
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the printer. Read only |
location | URI |
The URI of a valid location. Required if is_service is false. |
name | string |
The name of the workstation. For 'is_service is False' this field is required. For 'is_service is True' this field will be ignored. |
updated | iso-8601 datetime |
When the resource was last updated |
updated_by | URI |
The user that last updated the printer. |
uri | URL |
The URI (as a URL) of the resource, as a printer/post-processor/shipping URI |
workstation_type | string |
printer/ post-processor/ or shipping only. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
Create a new workstation ... does not work yet .
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
If archived, the datetime the post-processor was archived. Required |
description | string |
Description of printer Default: None |
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the printer. Read only Required |
location | URI |
The URI of a valid location. Required if is_service is false. Required |
name | string |
The name of the workstation. For 'is_service is False' this field is required. For 'is_service is True' this field will be ignored. Required |
updated | iso-8601 datetime |
When the resource was last updated Required |
updated_by | URI |
The user that last updated the printer. Required |
uri | URL |
The URI (as a URL) of the resource, as a printer/post-processor/shipping URI Default: None |
workstation_type | string |
printer/ post-processor/ or shipping only. Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
A Workstation is a physical location where a specific kind of work is done. Currently a Read-Only collection/Summary of Workstation types (printer/post-processor/shipping) that are stored in their own tables.
Workstation Printer:
Workstation Post-Processor:
Workstation Shipping:
NOTE: As of 2022-10-03 Workstation logic is mostly split into 'printer'/'post-processor'/'shipping' right now. This is the start of refactoring to a single workstation behavior is
Get a workstation by UUID.
Schema (application/json)
Property | Type | Description |
---|---|---|
archived | iso-8601 datetime |
If archived, the datetime the post-processor was archived. |
description | string |
Description of printer |
in_progress_max | integer |
Max number of concurrent runs that can be in progress on the printer. Read only |
location | URI |
The URI of a valid location. Required if is_service is false. |
name | string |
The name of the workstation. For 'is_service is False' this field is required. For 'is_service is True' this field will be ignored. |
updated | iso-8601 datetime |
When the resource was last updated |
updated_by | URI |
The user that last updated the printer. |
uri | URL |
The URI (as a URL) of the resource, as a printer/post-processor/shipping URI |
workstation_type | string |
printer/ post-processor/ or shipping only. |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
/zverse-conversion/
A Zverse Conversion is used when you upload a 'model' as a PDF conversion This represents the states/behavior of peer service ZVerse turning the PDF into a valid STL model, and then us adding/reloading that model.
HTTPS GET with no UUID does a list of available resources
Schema (application/json)
Property | Type | Description |
---|---|---|
complexity | string |
Complexity level for converting from PDF to STL. Choices
'"TBD|Low|LowMedium|Medium|High|Custom"'
|
complexity_value | integer |
Complexity value from the ZVerse API. |
cost | float |
Cost of converting this image/design to a proper 3D Model |
created | iso-8601 datetime |
When the ZVerse conversion was created (requested). |
currency | string |
The currency of the costs in this endpoint. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
filename | string |
File name of the PDF model file. |
model | URI |
This URL should point to a valid model resource that has already been uploaded. |
notes | string |
notes or errors on transaction |
status | string |
Status of conversion. 2nd Email or payment needed to trigger conversion Choices
'"new|pending|submitted|estimate-completed|approval-requested|approval-failed|conversion-approved|conversion-completed|complete|error"'
|
updated | iso-8601 datetime |
When the ZVerse conversion was updated |
uri | URI |
The URL of this very ZVerseConversion. |
zverse_id | string |
ZVerse internal ID tracking # |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
Schema (application/json)
Property | Type | Description |
---|---|---|
complexity | string |
Complexity level for converting from PDF to STL. Required Choices
'"TBD|Low|LowMedium|Medium|High|Custom"'
|
complexity_value | integer |
Complexity value from the ZVerse API. Required |
cost | float |
Cost of converting this image/design to a proper 3D Model Default: 0.0 |
created | iso-8601 datetime |
When the ZVerse conversion was created (requested). Required |
currency | string |
The currency of the costs in this endpoint. Required Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
filename | string |
File name of the PDF model file. Required |
model | URI |
This URL should point to a valid model resource that has already been uploaded. Required |
notes | string |
notes or errors on transaction Required |
status | string |
Status of conversion. 2nd Email or payment needed to trigger conversion Required Choices
'"new|pending|submitted|estimate-completed|approval-requested|approval-failed|conversion-approved|conversion-completed|complete|error"'
|
updated | iso-8601 datetime |
When the ZVerse conversion was updated Required |
uri | URI |
The URL of this very ZVerseConversion. Required |
zverse_id | string |
ZVerse internal ID tracking # Required |
Responses
Status Code | Description |
---|---|
204 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
A Zverse Conversion is used when you upload a 'model' as a PDF conversion This represents the states/behavior of peer service ZVerse turning the PDF into a valid STL model, and then us adding/reloading that model.
generic get one resource by exact UUID
Schema (application/json)
Property | Type | Description |
---|---|---|
complexity | string |
Complexity level for converting from PDF to STL. Choices
'"TBD|Low|LowMedium|Medium|High|Custom"'
|
complexity_value | integer |
Complexity value from the ZVerse API. |
cost | float |
Cost of converting this image/design to a proper 3D Model |
created | iso-8601 datetime |
When the ZVerse conversion was created (requested). |
currency | string |
The currency of the costs in this endpoint. Choices
'"AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CYP|CZK|DJF|DKK|DOP|DZD|EEK|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MTL|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|STD|SVC|SYP|SZL|THB|TJS|TMM|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFO|XFU|XOF|XPD|XPF|XPT|XTS|XXX|YER|ZAR|ZMK|ZWD"'
|
filename | string |
File name of the PDF model file. |
model | URI |
This URL should point to a valid model resource that has already been uploaded. |
notes | string |
notes or errors on transaction |
status | string |
Status of conversion. 2nd Email or payment needed to trigger conversion Choices
'"new|pending|submitted|estimate-completed|approval-requested|approval-failed|conversion-approved|conversion-completed|complete|error"'
|
updated | iso-8601 datetime |
When the ZVerse conversion was updated |
uri | URI |
The URL of this very ZVerseConversion. |
zverse_id | string |
ZVerse internal ID tracking # |
Responses
Status Code | Description |
---|---|
200 |
The request was successful |
403 |
You are not authorized to complete the request. |
404 |
The requested record cannot be found. |
-
POST
/model/
¶ Create a new model representation. A model is currently composed of a single STL file but this may be expanded in the future. A model resource is owned by the user who uploaded it. A certain amount of processing happens after uploading an STL, as such a callback URL can be provided, which will be called once processing is finished.
If a valid model is uploaded the system will produce a default snapshot of the model.
Request JSON Object: - name (string) – Required. The name of the model. This can be any string and should be meaningful to the user.
- allowed_transformations (obj) – Optional. The transformations that are allowed on this model.
- allowed_transformations.resize (boolean) – Optional. True if this model is allowed to be resized automatically by other services. Default: False.
- allowed_transformations.rotation (boolean) – Optional. True if this model is allowed to be rotated automatically by other services. Default: False.
- callback (obj) – Optional. The URL to call when this model changes states.
- callback.url (string) – Optional. The URL to request for the callback.
- callback.method (string) – Optional. The method to use for the request, one of GET, POST or PUT.
Example request
{ "name" : "Authentise's epic logo", "allowed_transformations" : { "resize" : True, "rotation" : True, }, "callback" : { "method" : "GET", "url" : "https://my.domain.net/some/location", } }
Response Headers: - Location – The URI of the model where information about the model can be requested. Ex: /model/<uuid>/
- X-Upload-Location – The URL where the data for the model can be uploaded. Ex: https://s3.amazonaws.com/authentise-models/?signature=foobar
Take note that when you upload your STL file to the X-Upload-Location that you must set the Content-Type header to
application/octet-stream
, otherwise the service will return 403 and indicate a signature mismatch.The callback will be requested on state change, particularly after the model has been uploaded and analyzed. The callback will work according to the Callback Service. After analysis the callback will indicate status has changed to either
error
orprocessed
depending on whether or not a valid model file was provided.
-
GET
/model/<uuid>/
¶ Get information about a model.
Permissions:
- Model owner
- System Admins
- Authentise Services
Response JSON Object: - analyses.manifold (bool) – A boolean representing if the model is manifold. If the model is not manifold, there is a higher likelihood that slicing will fail.
- callback_method (string) – The HTTP method to use when requesting the callback URL. One of GET or POST
- callback_uri (string) – The URL to request on status change for this model
- content (string) – The URL of a link at which a the model can be downloaded.
- created (datetime) – The date and time the model was created.
- name (string) – The name of the model.
- size.x (float) – The size of the model in the X direction in millimeters
- size.y (float) – The size of the model in the Y direction in millimeters
- size.z (float) – The size of the model in the Z direction in millimeters
- snapshot (string) – The URL of the snapshot resource that was automatically generated for this model
- status (string) – The current status of the model processing. Can be one of processing, processed, or error.
- surface_area (float) – The surface area of the model in millimeters
- updated (datetime) – The datetime of the last time this model was updated
- upload-location (URL) – If the model has not been uploaded this will contain a URL where the model can be uploaded
- uri (URI) – The URI of this model
- user_uri (URI) – The URI of the owner and creator of the model
- volume (float) – The volume of the model in millimeters
- updated – The date and time the model was last updated.
Response JSON Array of Objects: - children (string) – An array of model URIs from which are derived from this model.
- parents (string) – An array of model URIs from which this model is derived.
-
GET
/model/
¶ Get a list of all models the requester has access to based on query filters.
Query Parameters: - name – a partial name of models to search for. accepts the wildcard character: “*”.
- status – a status of models to search for.
- created – a creation date to search for models.
- updated – an updated date to search for models.
- sort – one of the other queryable parameters, such as
name
,status
,created
orupdated
. accepts+
or-
to indicate order of the sort. Parameters may be strung together, separated by commas. Example:+status, +created, -name
orname, created
Response JSON Array of Objects: - models (string) – A list of models which match the query filter and which the caller has permissions. Each item in the list has the same data as
GET /model/<uuid>/
, along with the resource URI.
-
POST
/model/<uuid>/transformation/
¶ API to apply a transformation to a model. Creates a new model resource which is a child of the input model. This endpoint takes in an array of transformations, ordered in the order the transformations should be applied. Each transformation type has a corresponding parameter set that must be included with the type.
Request JSON Array of Objects: - transformations.[].type (string) – Required The type of operation being applied. Valid types are
bracket
,auto-rotate
,rotate
,auto-scale
,scale
,auto-translate
andtranslate
. - transformations.[].parametersBrackets (object) – A JSON object with the valid transformation parameters for the
bracket
type. - transformations.[].parametersBrackets.width (float) – Required for ``bracket`` type. The width (X and Y) of the bracket, in mm.
- transformations.[].parametersBrackets.gap (float) – Required for ``bracket`` type. The distance from the bracket to the model, in mm.
- transformations.[].parametersBrackets.thickness (float) – Required for ``bracket`` type. The thickness (Z) of the bracket, in mm.
- transformations.[].parametersAutoRotate (object) – A JSON object with the valid transformation parameters for the
auto-rotate
type. - transformations.[].parametersAutoRotate.build.x (float) – Required for ``auto-rotate`` type. The size of the build volume in mm in the X direction.
- transformations.[].parametersAutoRotate.build.y (float) – Required for ``auto-rotate`` type. The size of the build volume in mm in the Y direction.
- transformations.[].parametersAutoRotate.build.z (float) – Required for ``auto-rotate`` type. The size of the build volume in mm in the Z direction.
- transformations.[].parametersRotate (object) – A JSON object with the valid transformation parameters for the
rotate
type. The rotations are applied in a specific order: The X rotation is applied first, then the Y rotation, and finally the Z rotation. - transformations.[].parametersRotate.x (float) – Required for ``rotate`` type. The amount of rotation, in degrees, about the X axis. This rotation is applied first.
- transformations.[].parametersRotate.y (float) – Required for ``rotate`` type. The amount of rotation, in degrees, about the Y axis. This rotation is applied second.
- transformations.[].parametersRotate.z (float) – Required for ``rotate`` type. The amount of rotation, in degrees, about the Z axis. This rotation is applied last.
- transformations.[].parametersAutoScale (object) – A JSON object with the valid transformation parameters for the
auto-scale
type. - transformations.[].parametersAutoScale.build.x (float) – Required for ``auto-scale`` type. The size of the build volume in mm in the X direction.
- transformations.[].parametersAutoScale.build.y (float) – Required for ``auto-scale`` type. The size of the build volume in mm in the Y direction.
- transformations.[].parametersAutoScale.build.z (float) – Required for ``auto-scale`` type. The size of the build volume in mm in the Z direction.
- transformations.[].parametersScale (object) – A JSON object with the valid transformation parameters for the
scale
type. - transformations.[].parameterScale.x (float) – Required for ``scale`` type. The percent scaling in the Z axis.
- transformations.[].parameterScale.y (float) – Required for ``scale`` type. The percent scaling in the Y axis.
- transformations.[].parameterScale.z (float) – Required for ``scale`` type. The percent scaling in the Z axis.
- transformations.[].parametersTranslate (object) – A JSON object with the valid transformation parameters for the
translate
type. - transformations.[].parametersTranslate.x (float) – Required for ``translate`` type. The translation in mm in the Z direction from the current location of the model.
- transformations.[].parametersTranslate.y (float) – Required for ``translate`` type. The translation in mm in the Y direction from the current location of the model.
- transformations.[].parametersTranslate.z (float) – Required for ``translate`` type. The translation in mm in the Z direction from the current location of the model.
Request JSON Object: - callback.url (string) – The URL to callback to once model processing is finished.
- callback.method (string) – The HTTP method for the callback to use when calling back.
Response Headers: - Location – The URI of this model where information about the model can be requested. Example: /model/1234-abcde/
Example request
POST /model/<uuid>/transformation/ { "transformations": [{ type: “bracket”, parametersBrackets: { width: 10mm, grap: 2mm, thickness: 2mm } },{ type: “auto-rotate”, parametersAutoRotate: { build: { x: 100, y: 160, z: 230 } } },{ type: “rotate”, parametersRotate: { x: 23, y: 10, z: 12 } },{ type: "auto-scale”, parametersAutoScale: { x: 45, y: 0, z: 45 } },{ type: “scale”, parametersScale: { build: { x: 10, y: 10, z: 10 } } },{ type: “translate”, parametersTranslate: { x: 100, y: 20, z: 0 } },{ type: “translate” }], "callback": { "url": "https://somesite.com/a/callback/url/", "method": "GET" } }
- transformations.[].type (string) – Required The type of operation being applied. Valid types are
-
POST
/model/<uuid>/snapshot/
¶ Create a snapshot of a given model based on request parameters. This can be a potentially long process, so a URL to check the progress and download the snapshot is given as the response.
The values for x, y, z and u, v, w are optional. If they are not provided the system will attempt to produce a snapshot that frames the model well. We call this the default snapshot and a snapshot from this position will be produced for every valid model that is uploaded.
Request JSON Object: - samples (int) – The number of samples to use in requesting the snapshot. Min 0, Max 5000. Higher numbers will take longer but yield better-looking results.
- layer (int) – The number of the layer of the model to show. This allows you to visualize the model when partially printed.
- color (string) – The color in HTML color codes, to use for the material the model is made of. Example: #AFAA75
- height (int) – The height of the image in pixels. Min 0, Max 768.
- width (int) – The width of the image in pixels. Min 0, Max 1024.
- x (float) – The position of the camera on the X axis
- y (float) – The position of the camera on the Y axis
- z (float) – The position of the camera on the Z axis
- u (float) – The camera direction vector’s X component
- v (float) – The camera direction vector’s Y component
- w (float) – The camera direction vector’s Z component
- callback.url (string) – The URL to callback to once model processing is finished.
- callback.method (string) – The HTTP method for the callback to use when calling back.
Response Headers: - Location – The URI of the snapshot where information about the snapshot can be requested. Example: /model/<uuid>/snapshot/<uuid>/
-
GET
/model/<uuid>/snapshot/<uuid>/
¶ Get information about the snapshot.
Response JSON Object: - samples (int) – The number of samples to use in requesting the snapshot. Min 0, Max 5000. Higher numbers will take longer but yield better-looking results.
- layer (int) – The number of the layer of the model to show. This allows you to visualize the model when partially printed.
- color (string) – The color, in HTML color codes, to use for the material the model is made of. Ex: #AFAA75
- height (int) – The height of the image in pixels. Min 0, Max 768.
- width (int) – The width of the image in pixels. Min 0, Max 1024.
- x (float) – The position of the camera on the X axis.
- y (float) – The position of the camera on the Y axis.
- z (float) – The position of the camera on the Z axis.
- u (float) – The camera direction vector’s X component.
- v (float) – The camera direction vector’s Y component.
- w (float) – The camera direction vector’s Z component.
- content (string) – The URL of a link at which a the snapshot can be downloaded.