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

Get information about the service like the current version. Useful for testing the service is 'up'

Get service metadata

Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
name string none available
Required
secret string none available
Default: None
user_uuid uuid none available
Default: None
uuid uuid none available
Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
name string none available
secret string none available
user_uuid uuid none available
uuid uuid none available
Responses
Status CodeDescription
200

The request was successful

/asset-version/

get post

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)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

Create a new asset version.

Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
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)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

/asset/

get post

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)
PropertyTypeDescription
action string none available
Choices
  • mesh_heal_via_Authentise
  • processing_mesh_heal_via_Authentise
Example: '"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 none available
created iso-8601 datetime none available
description string

Description of the Asset


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
Example: '"in|mm"'
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, but we return data in user_unit here


Example: '{}'
snapshot string none available
snapshot_content string none available
status string none available
Choices
  • not-uploaded
  • processing
  • processed
  • external-process
  • error
  • repaired
  • irreparable
  • inoperable
Example: '"not-uploaded|processing|processed|external-process|error|repaired|irreparable|inoperable"'
surface_area_mm float

The surface area is in mm as unit at API level, not in user_units.


type string none available
Choices
  • 3dm
  • 3dpdf
  • 3ds
  • 3mf
  • amf
  • asm
  • catpart
  • catproduct
  • dae
  • dxf
  • fbx
  • iam
  • icd
  • iges
  • igs
  • ipt
  • jt
  • model
  • obj
  • parasolid
  • pdf
  • ply
  • prt
  • sat
  • skp
  • slc
  • sldasm
  • sldprt
  • step
  • stl
  • vdafs
  • vda
  • vrml
  • wrl
  • x_t
  • zcp
  • zpr
Example: '"3dm|3dpdf|3ds|3mf|amf|asm|catpart|catproduct|dae|dxf|fbx|iam|icd|iges|igs|ipt|jt|model|obj|parasolid|pdf|ply|prt|sat|skp|slc|sldasm|sldprt|step|stl|vdafs|vda|vrml|wrl|x_t|zcp|zpr"'
updated iso-8601 datetime none available
upload-location string none available
uri URI none available
user_unit string

Units users wants this API to return data in (inch, mm). Some old data is file_unit always.


Choices
  • in
  • mm
Example: '"in|mm"'
user_uri URI none available
versions array

List of Asset-Versions tied to a particular Asset


Example: '["..."]'
virus_scan string

Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected.


Choices
  • unscanned
  • passed
  • quarantined
Example: '"unscanned|passed|quarantined"'
volume_mm float

The volume is in mm as unit at API level, not in user_units.


Responses
Status CodeDescription
200

The request was successful

404

generated-exception-class raised

Create a new asset.

Schema (application/json)
PropertyTypeDescription
action string none available
Default: None
Choices
  • mesh_heal_via_Authentise
  • processing_mesh_heal_via_Authentise
Example: '"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 none available
Default: None
created iso-8601 datetime none available
Default: None
description string

Description of the Asset


Default: None
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
Example: '"in|mm"'
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, but we return data in user_unit here


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
  • processing
  • processed
  • external-process
  • error
  • repaired
  • irreparable
  • inoperable
Example: '"not-uploaded|processing|processed|external-process|error|repaired|irreparable|inoperable"'
surface_area_mm float

The surface area is in mm as unit at API level, not in user_units.


Default: None
type string none available
Required
Choices
  • 3dm
  • 3dpdf
  • 3ds
  • 3mf
  • amf
  • asm
  • catpart
  • catproduct
  • dae
  • dxf
  • fbx
  • iam
  • icd
  • iges
  • igs
  • ipt
  • jt
  • model
  • obj
  • parasolid
  • pdf
  • ply
  • prt
  • sat
  • skp
  • slc
  • sldasm
  • sldprt
  • step
  • stl
  • vdafs
  • vda
  • vrml
  • wrl
  • x_t
  • zcp
  • zpr
Example: '"3dm|3dpdf|3ds|3mf|amf|asm|catpart|catproduct|dae|dxf|fbx|iam|icd|iges|igs|ipt|jt|model|obj|parasolid|pdf|ply|prt|sat|skp|slc|sldasm|sldprt|step|stl|vdafs|vda|vrml|wrl|x_t|zcp|zpr"'
updated iso-8601 datetime none available
Default: None
upload-location string none available
Default: None
uri URI none available
Default: None
user_unit string

Units users wants this API to return data in (inch, mm). Some old data is file_unit always.


Default: mm
Choices
  • in
  • mm
Example: '"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

Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected.


Default: unscanned
Choices
  • unscanned
  • passed
  • quarantined
Example: '"unscanned|passed|quarantined"'
volume_mm float

The volume is in mm as unit at API level, not in user_units.


Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

generated-exception-class raised

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)
PropertyTypeDescription
action string none available
Choices
  • mesh_heal_via_Authentise
  • processing_mesh_heal_via_Authentise
Example: '"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 none available
created iso-8601 datetime none available
description string

Description of the Asset


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
Example: '"in|mm"'
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, but we return data in user_unit here


Example: '{}'
snapshot string none available
snapshot_content string none available
status string none available
Choices
  • not-uploaded
  • processing
  • processed
  • external-process
  • error
  • repaired
  • irreparable
  • inoperable
Example: '"not-uploaded|processing|processed|external-process|error|repaired|irreparable|inoperable"'
surface_area_mm float

The surface area is in mm as unit at API level, not in user_units.


type string none available
Choices
  • 3dm
  • 3dpdf
  • 3ds
  • 3mf
  • amf
  • asm
  • catpart
  • catproduct
  • dae
  • dxf
  • fbx
  • iam
  • icd
  • iges
  • igs
  • ipt
  • jt
  • model
  • obj
  • parasolid
  • pdf
  • ply
  • prt
  • sat
  • skp
  • slc
  • sldasm
  • sldprt
  • step
  • stl
  • vdafs
  • vda
  • vrml
  • wrl
  • x_t
  • zcp
  • zpr
Example: '"3dm|3dpdf|3ds|3mf|amf|asm|catpart|catproduct|dae|dxf|fbx|iam|icd|iges|igs|ipt|jt|model|obj|parasolid|pdf|ply|prt|sat|skp|slc|sldasm|sldprt|step|stl|vdafs|vda|vrml|wrl|x_t|zcp|zpr"'
updated iso-8601 datetime none available
upload-location string none available
uri URI none available
user_unit string

Units users wants this API to return data in (inch, mm). Some old data is file_unit always.


Choices
  • in
  • mm
Example: '"in|mm"'
user_uri URI none available
versions array

List of Asset-Versions tied to a particular Asset


Example: '["..."]'
virus_scan string

Lists the state of the virus-scan on the file. Status quarantined indicates a problem was detected.


Choices
  • unscanned
  • passed
  • quarantined
Example: '"unscanned|passed|quarantined"'
volume_mm float

The volume is in mm as unit at API level, not in user_units.


Responses
Status CodeDescription
200

The request was successful

404

generated-exception-class raised

/assignment/

get post

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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 CodeDescription
200

The request was successful

400

NotImplementedError

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)
PropertyTypeDescription
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
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

400

NotImplementedError

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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 CodeDescription
200

The request was successful

400

NotImplementedError

403

You are not authorized to complete the request.

Action not allowed by permissions.

404

The requested assignment cannot be found.

/build/

get post

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)
PropertyTypeDescription
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
Example: '"complete|failed|machine_error|new|part_exceeds_boundaries|processing|suspended|user_abort"'
updated iso-8601 datetime

When the cassette resource was updated


uri URI

The URI for this build


Responses
Status CodeDescription
200

The request was successful

404

The build requested cannot be found

Create a new build

Schema (application/json)
PropertyTypeDescription
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
Example: '"complete|failed|machine_error|new|part_exceeds_boundaries|processing|suspended|user_abort"'
updated iso-8601 datetime

When the cassette resource was updated


Default: None
uri URI

The URI for this build


Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

The build requested cannot be found

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)
PropertyTypeDescription
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
Example: '"complete|failed|machine_error|new|part_exceeds_boundaries|processing|suspended|user_abort"'
updated iso-8601 datetime

When the cassette resource was updated


uri URI

The URI for this build


Responses
Status CodeDescription
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)
PropertyTypeDescription
bureau URI

Bureau URI


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
Example: '"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
Example: '"b|u|r|e|a|u"'
order_pretable_text string

Order Quote pre table text


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"b|u|r|e|a|u"'
order_show_page_number boolean

Is pages number visible in Order Quote


Choices
  • True
  • False
Example: '"True|False"'
order_table_bg_color string

Order Quote table background color


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"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
Example: '"b|u|r|e|a|u"'
order_table_footer string

Order Quote table footer text


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"b|u|r|e|a|u"'
order_table_header_bg_color string

Order Quote header background color


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"b|u|r|e|a|u"'
order_table_header_color string

Order Quote header color


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"b|u|r|e|a|u"'
order_table_post_table string

Order Quote table post table text


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"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
Example: '"b|u|r|e|a|u"'
order_table_show_column_borders boolean

Is column borders visible in Order Quote


Choices
  • True
  • False
Example: '"True|False"'
order_table_show_row_borders boolean

Is row borders visible in Order Quote


Choices
  • True
  • False
Example: '"True|False"'
uri URI

The bureau settings URI


Responses
Status CodeDescription
200

The request was successful

400

RecordNotFound: Bureau branding with passed UUID does not exist.

403

PermissionsForbiddenError: You do not have access to the branding of this bureau.

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)
PropertyTypeDescription
bureau URI

Bureau URI


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
Example: '"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
Example: '"b|u|r|e|a|u"'
order_pretable_text string

Order Quote pre table text


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"b|u|r|e|a|u"'
order_show_page_number boolean

Is pages number visible in Order Quote


Choices
  • True
  • False
Example: '"True|False"'
order_table_bg_color string

Order Quote table background color


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"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
Example: '"b|u|r|e|a|u"'
order_table_footer string

Order Quote table footer text


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"b|u|r|e|a|u"'
order_table_header_bg_color string

Order Quote header background color


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"b|u|r|e|a|u"'
order_table_header_color string

Order Quote header color


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"b|u|r|e|a|u"'
order_table_post_table string

Order Quote table post table text


Choices
  • b
  • u
  • r
  • e
  • a
  • u
Example: '"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
Example: '"b|u|r|e|a|u"'
order_table_show_column_borders boolean

Is column borders visible in Order Quote


Choices
  • True
  • False
Example: '"True|False"'
order_table_show_row_borders boolean

Is row borders visible in Order Quote


Choices
  • True
  • False
Example: '"True|False"'
uri URI

The bureau settings URI


Responses
Status CodeDescription
200

The request was successful

400

RecordNotFound: Bureau branding with passed UUID does not exist.

403

PermissionsForbiddenError: You do not have access to the branding of this bureau.

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)
PropertyTypeDescription
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.


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
Example: '"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
Example: '"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


hourly_design_cost float

Price per hour for design work.


mes_base_format string

Main file type used for MES data operations. Order Entry may support different formats.


Choices
  • stl
  • 3mf
Example: '"stl|3mf"'
notification_custom_emails array

List of custom email addresses to which the notification should be sent.


Example: '["..."]'
notification_guest_registered email

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
Example: '"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
Example: '"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
Example: '"0|1|4|5"'
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
Example: '"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
Example: '"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
Example: '"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
Example: '"never|always|ask_each_time"'
uri URI

The bureau settings URI.


Responses
Status CodeDescription
200

The request was successful

400

RecordNotFound: Bureau settings with passed UUID does not exist.

403

PermissionsForbiddenError: You do not have access to the settings of this bureau.

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)
PropertyTypeDescription
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.


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
Example: '"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
Example: '"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


hourly_design_cost float

Price per hour for design work.


mes_base_format string

Main file type used for MES data operations. Order Entry may support different formats.


Choices
  • stl
  • 3mf
Example: '"stl|3mf"'
notification_custom_emails array

List of custom email addresses to which the notification should be sent.


Example: '["..."]'
notification_guest_registered email

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
Example: '"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
Example: '"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
Example: '"0|1|4|5"'
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
Example: '"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
Example: '"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
Example: '"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
Example: '"never|always|ask_each_time"'
uri URI

The bureau settings URI.


Responses
Status CodeDescription
200

The request was successful

400

RecordNotFound: Bureau settings with passed UUID does not exist.

403

PermissionsForbiddenError: You do not have access to the settings of this bureau.

/bureau/

get post

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)
PropertyTypeDescription
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 CodeDescription
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

UserServiceCommunicationError: Your request could not be completed because the user service is unavailable

Create a new bureau.

Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
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

UserServiceCommunicationError: Your request could not be completed because the user service is unavailable

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)
PropertyTypeDescription
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 CodeDescription
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

UserServiceCommunicationError: Your request could not be completed because the user service is unavailable

Get the parsed content of a capture file

Get the parsed content of a capture by UUID

Schema (application/json)
Responses
Status CodeDescription
200

The request was successful

404

not-yet-uploaded

file-not-found

Get the parsed content of a capture file

Get the parsed content of a capture by UUID

Schema (application/json)
Responses
Status CodeDescription
200

The request was successful

404

not-yet-uploaded

file-not-found

Information about the a modeler-type's capture-type. This is just a placeholder and currently is not implemented.

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

400

NotImplementedError

Information about the a modeler-type's capture-type. This is just a placeholder and currently is not implemented.

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

400

NotImplementedError

/capture/

get post

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)
PropertyTypeDescription
capture_type URI

The URI of the capture-type this capture uses


capture_type_name string

Name of capture type


Choices
  • arcam.job.log
  • carbon3D.modeler.status
  • catex.modeler.jobs
  • catex.modeler.status
  • connex.modeler.log
  • eos_connect.modeler.log
  • eos.modeler.log
  • hp.modeler.status
  • j750.modeler.status
  • slm.modeler.status
  • projet660.modeler.log
  • ultimaker.modeler.log
Example: '"arcam.job.log|carbon3D.modeler.status|catex.modeler.jobs|catex.modeler.status|connex.modeler.log|eos_connect.modeler.log|eos.modeler.log|hp.modeler.status|j750.modeler.status|slm.modeler.status|projet660.modeler.log|ultimaker.modeler.log"'
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
Example: '"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 CodeDescription
200

The request was successful

404

RecordNotFound raised

RecordNotFound raised

Create a new capture

Schema (application/json)
PropertyTypeDescription
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
  • carbon3D.modeler.status
  • catex.modeler.jobs
  • catex.modeler.status
  • connex.modeler.log
  • eos_connect.modeler.log
  • eos.modeler.log
  • hp.modeler.status
  • j750.modeler.status
  • slm.modeler.status
  • projet660.modeler.log
  • ultimaker.modeler.log
Example: '"arcam.job.log|carbon3D.modeler.status|catex.modeler.jobs|catex.modeler.status|connex.modeler.log|eos_connect.modeler.log|eos.modeler.log|hp.modeler.status|j750.modeler.status|slm.modeler.status|projet660.modeler.log|ultimaker.modeler.log"'
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
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

RecordNotFound raised

RecordNotFound raised

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)
PropertyTypeDescription
capture_type URI

The URI of the capture-type this capture uses


capture_type_name string

Name of capture type


Choices
  • arcam.job.log
  • carbon3D.modeler.status
  • catex.modeler.jobs
  • catex.modeler.status
  • connex.modeler.log
  • eos_connect.modeler.log
  • eos.modeler.log
  • hp.modeler.status
  • j750.modeler.status
  • slm.modeler.status
  • projet660.modeler.log
  • ultimaker.modeler.log
Example: '"arcam.job.log|carbon3D.modeler.status|catex.modeler.jobs|catex.modeler.status|connex.modeler.log|eos_connect.modeler.log|eos.modeler.log|hp.modeler.status|j750.modeler.status|slm.modeler.status|projet660.modeler.log|ultimaker.modeler.log"'
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
Example: '"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 CodeDescription
200

The request was successful

404

RecordNotFound raised

RecordNotFound raised

/cassette/

get post

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

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"active|loaded|unknown"'
uri URI

The unique URI of this cassette in 3DIAX


Responses
Status CodeDescription
200

The request was successful

Create a new cassette

Schema (application/json)
PropertyTypeDescription
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
Example: '"active|loaded|unknown"'
uri URI

The unique URI of this cassette in 3DIAX


Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
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

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"active|loaded|unknown"'
uri URI

The unique URI of this cassette in 3DIAX


Responses
Status CodeDescription
200

The request was successful

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
  • run
  • service_provider_job
  • piece
Example: '"order|line_item|prep_task_record|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
Example: '"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 CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
  • run
  • service_provider_job
  • piece
Example: '"order|line_item|prep_task_record|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
Example: '"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 CodeDescription
200

The request was successful

404

The requested comment action cannot be found.

/comment/

get post

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).

No description provided
Schema (application/json)
PropertyTypeDescription
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|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
  • run
  • service_provider_job
  • piece
Example: '"order|line_item|prep_task_record|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.


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

The request was successful

403

Modification of the comment allowed only for comment owner.

404

The requested comment cannot be found.

No description provided
Schema (application/json)
PropertyTypeDescription
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|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
  • run
  • service_provider_job
  • piece
Example: '"order|line_item|prep_task_record|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.


Required
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

403

Modification of the comment allowed only for comment owner.

404

The requested comment cannot be found.

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).

No description provided
Schema (application/json)
PropertyTypeDescription
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|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
  • run
  • service_provider_job
  • piece
Example: '"order|line_item|prep_task_record|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.


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

The request was successful

403

Modification of the comment allowed only for comment owner.

404

The requested comment cannot be found.

/config/

get post

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
content string none available
description string none available
engine string none available
Choices
  • slic3r
Example: '"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 CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
content string none available
Default: None
description string none available
Default:
engine string none available
Default: slic3r
Choices
  • slic3r
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
description string none available
Default:
engine string none available
Required
Choices
  • slic3r
Example: '"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"}')
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
content string none available
Required
description string none available
Default:
engine string none available
Required
Choices
  • slic3r
Example: '"slic3r"'
name string none available
Default:
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
content string none available
description string none available
engine string none available
Choices
  • slic3r
Example: '"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 CodeDescription
200

The request was successful

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

The request was successful

400

DuplicateUpload

FileNotUploaded

RequiresContentType

404

RecordNotFound

/cost-report/

get post

This is the main resource for cost reporting over a given period of time.

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
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

No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
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/

get post

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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, prints in this run cannot be added or removed


notes string

System Notes for the run creation process.


pieces array

The URIs of prints in the run.


Example: '["..."]'
pieces_count integer

The count of all pieces, used in the process.


printer URI

The URI of run's printer.


printer_name string

Name of the related printer,


printing_run URI

The URI of the resulting printing run.


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
Example: '"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 CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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, prints in this run cannot be added or removed


Default: True
notes string

System Notes for the run creation process.


Required
pieces array

The URIs of prints in the run.


Required
Example: '["..."]'
pieces_count integer

The count of all pieces, used in the process.


Required
printer URI

The URI of run's printer.


Required
printer_name string

Name of the related printer,


Required
printing_run URI

The URI of the resulting printing run.


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
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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, prints in this run cannot be added or removed


notes string

System Notes for the run creation process.


pieces array

The URIs of prints in the run.


Example: '["..."]'
pieces_count integer

The count of all pieces, used in the process.


printer URI

The URI of run's printer.


printer_name string

Name of the related printer,


printing_run URI

The URI of the resulting printing run.


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
Example: '"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 CodeDescription
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 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)
PropertyTypeDescription
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
Example: '"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 CodeDescription
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)
PropertyTypeDescription
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
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
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)
PropertyTypeDescription
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
Example: '"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 CodeDescription
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.

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
Responses
Status CodeDescription
204

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
Responses
Status CodeDescription
200

The request was successful

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.

No description provided
Schema (application/json)
PropertyTypeDescription
default_value string

Default value for Custom Field Value on create.


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
Example: '"currency"'
is_smart boolean

Is field 'smart': used in business logic.


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 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
Example: '"text|textarea|table|integer|float|array|date|checkbox"'
uri URI

The URI of the custom field.


Responses
Status CodeDescription
200

The request was successful

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.

No description provided
Schema (application/json)
PropertyTypeDescription
default_value string

Default value for Custom Field Value on create.


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
Example: '"currency"'
is_smart boolean

Is field 'smart': used in business logic.


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 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
Example: '"text|textarea|table|integer|float|array|date|checkbox"'
uri URI

The URI of the custom field.


Responses
Status CodeDescription
200

The request was successful

404

RecordNotFound raised

/document/

get post

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)
PropertyTypeDescription
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
Example: '"bureau_branding|line_item|order|run|work_instruction_report|material|model_library|order_packing_slip|material_batch|material_batch_action|material_lot"'
related_uuid uuid

The UUID of the resource (related table), for which should be uploaded the document.


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
Example: '"unscanned|passed|quarantined"'
Responses
Status CodeDescription
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)
PropertyTypeDescription
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
Example: '"bureau_branding|line_item|order|run|work_instruction_report|material|model_library|order_packing_slip|material_batch|material_batch_action|material_lot"'
related_uuid uuid

The UUID of the resource (related table), for which should be uploaded the document.


Required
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
Example: '"unscanned|passed|quarantined"'
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

403

You are not authorized to complete the request.

404

The requested document cannot be found.

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

No description provided
Schema (application/json)
PropertyTypeDescription
name string

The name of the document.


Required
* These properties are required when POSTing
Responses
Status CodeDescription
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)
PropertyTypeDescription
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
Example: '"bureau_branding|line_item|order|run|work_instruction_report|material|model_library|order_packing_slip|material_batch|material_batch_action|material_lot"'
related_uuid uuid

The UUID of the resource (related table), for which should be uploaded the document.


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
Example: '"unscanned|passed|quarantined"'
Responses
Status CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested document cannot be found.

/downtime/

get post

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)
PropertyTypeDescription
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 CodeDescription
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)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
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)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

400

The requested downtime name already exists.

404

The requested downtime cannot be found.

/ecco/

post

This endpoint gathers data about ecco installations

No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

This endpoint gathers data about ecco installations

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
Responses
Status CodeDescription
204

The request was successful

/event/

get

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)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested event cannot be found.

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)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested event cannot be found.

This is the resource for estimating material, and time usage for a print

No description provided
Schema (application/json)
PropertyTypeDescription
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"'
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

This is the resource for estimating material, and time usage for a print

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

/feature/

get post

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)
PropertyTypeDescription
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
  • order-quote-special-processing
  • user-can-update-estimates
  • model-unit-default-mm
  • specimen-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
Example: '"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|order-quote-special-processing|user-can-update-estimates|model-unit-default-mm|specimen-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"'
uri URI

The URI of the feature.


Responses
Status CodeDescription
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)
PropertyTypeDescription
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
  • order-quote-special-processing
  • user-can-update-estimates
  • model-unit-default-mm
  • specimen-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
Example: '"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|order-quote-special-processing|user-can-update-estimates|model-unit-default-mm|specimen-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"'
uri URI

The URI of the feature.


Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
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.

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)
PropertyTypeDescription
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
  • order-quote-special-processing
  • user-can-update-estimates
  • model-unit-default-mm
  • specimen-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
Example: '"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|order-quote-special-processing|user-can-update-estimates|model-unit-default-mm|specimen-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"'
uri URI

The URI of the feature.


Responses
Status CodeDescription
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/

get post

Endpoint for internal storage of data

GET LIST. This only works for internal users.

Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

400

DuplicateKeyError

404

RecordNotFound

No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

400

DuplicateKeyError

404

RecordNotFound

Endpoint for internal storage of data

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

400

DuplicateKeyError

404

RecordNotFound

/flat-line-item/

get post

Returns Flat Line Item object Used generally for Microsoft Flow

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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"'
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
Example: '"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.


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
Example: '"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.


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


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.


Responses
Status CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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"'
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
Example: '"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
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
Example: '"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
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
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

Returns Flat Line Item object Used generally for Microsoft Flow

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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"'
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
Example: '"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.


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
Example: '"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.


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


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.


Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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 CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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 CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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 CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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 CodeDescription
200

The request was successful

/flat-order/

get post

Returns Flat Order object Used generally for Microsoft Flow

No description provided
Schema (application/json)
PropertyTypeDescription
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.


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


finance_review string

Order Finance Review


funding_vehicle string

Order Funding Vehicle


ip_sensitivity string

The intellectual property sensitivity.


ipt string

Order IPT


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


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

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
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
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
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
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
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

Returns Flat Order object Used generally for Microsoft Flow

No description provided
Schema (application/json)
PropertyTypeDescription
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.


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


finance_review string

Order Finance Review


funding_vehicle string

Order Funding Vehicle


ip_sensitivity string

The intellectual property sensitivity.


ipt string

Order IPT


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


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

The request was successful

/flat-piece/

get post

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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 CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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 CodeDescription
200

The request was successful

/gcode/

get post

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"not-uploaded|processing|processed|error"'
uri URI

GCode URI


Responses
Status CodeDescription
200

The request was successful

403

Unauthorized: You are not authorized to complete the request.

404

RecordNotFound

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"not-uploaded|processing|processed|error"'
uri URI

GCode URI


Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

403

Unauthorized: You are not authorized to complete the request.

404

RecordNotFound

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"not-uploaded|processing|processed|error"'
uri URI

GCode URI


Responses
Status CodeDescription
200

The request was successful

403

Unauthorized: You are not authorized to complete the request.

404

RecordNotFound

/groups/

get post

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
description string none available
name string none available
secret string none available
subgroups array none available
Example: '["..."]'
uri string none available
Responses
Status CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
description string none available
name string none available
secret string none available
subgroups array none available
Example: '["..."]'
uri string none available
Responses
Status CodeDescription
200

The request was successful

Get the data about all Support Strategy

No description provided
Schema (application/json)
PropertyTypeDescription
name string

The name of the infill strategy.


Choices
  • n
  • a
  • m
  • e
Example: '"n|a|m|e"'
uri URI

The URI of the infill strategy.


Responses
Status CodeDescription
200

The request was successful

404

RecordNotFound raised

Get the data about all Support Strategy

No description provided
Schema (application/json)
PropertyTypeDescription
name string

The name of the infill strategy.


Choices
  • n
  • a
  • m
  • e
Example: '"n|a|m|e"'
uri URI

The URI of the infill strategy.


Responses
Status CodeDescription
200

The request was successful

404

RecordNotFound raised

Get the list of downloads that are available for the different clients we release

No description provided
Schema (application/json)
PropertyTypeDescription
architecture string

The CPU architecture the installer is for


Choices
  • x86
  • amd64
Example: '"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
Example: '"AuthentiseUpdate|CatalystSlicer|Echo|StreamicsConnector"'
platform string

The platform, such as Windows or Mac


Choices
  • mac
  • windows
Example: '"mac|windows"'
type string

The type of installer, IE what method it uses to install


Choices
  • exe
  • msi
Example: '"exe|msi"'
version string

The version of the installer


Example: '"1.2.3"'
Responses
Status CodeDescription
200

The request was successful

/job/

post

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
body string none available
Required
method string none available
Required
Choices
  • GET
  • PUT
  • POST
Example: '"GET|PUT|POST"'
url string none available
Required
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

" Endpoint to apply a label to one item.

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

404

The requested order cannot be found.

No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

The requested order cannot be found.

" Endpoint to apply a label to one item.

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

404

The requested order cannot be found.

/label/

get post

" 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)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

404

The requested label cannot be found.

No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

The requested label cannot be found.

" 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

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

404

The requested label cannot be found.

/layout/

post

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)
PropertyTypeDescription
build object

Information about the build volume. The type field must be rectangular for now.All dimensions are measured in millimeters (mm)


Required
Example: '{"type": "rectangle", "packer_type": "pack2d|pack3d"}'
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 queued to processing to either complete or error


Default: queued
Choices
  • complete
  • error
  • processing
  • queued
Example: '"queued, processing, complete, error"'
uri URI

The URI of the layout.


Required
* These properties are required when POSTing
Responses
Status CodeDescription
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.

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)
PropertyTypeDescription
build object

Information about the build volume. The type field must be rectangular for now.All dimensions are measured in millimeters (mm)


Example: '{"type": "rectangle", "packer_type": "pack2d|pack3d"}'
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 queued to processing to either complete or error


Choices
  • complete
  • error
  • processing
  • queued
Example: '"queued, processing, complete, error"'
uri URI

The URI of the layout.


Responses
Status CodeDescription
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.

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)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested line item actuals cannot be found.

405

MethodNotAllowed

No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

403

You are not authorized to complete the request.

404

The requested line item actuals cannot be found.

405

MethodNotAllowed

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)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested line item actuals cannot be found.

405

MethodNotAllowed

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)
PropertyTypeDescription
action string none available
Choices
  • upload
  • download
Example: '"upload|download"'
forge_folder_id string none available
forge_project_id string none available
last_action string none available
Choices
  • upload
  • download
Example: '"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
Example: '"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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested netfab integration cannot be found.

No description provided
Schema (application/json)
PropertyTypeDescription
action string none available
Required
Choices
  • upload
  • download
Example: '"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
Example: '"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
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
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)
PropertyTypeDescription
action string none available
Choices
  • upload
  • download
Example: '"upload|download"'
forge_folder_id string none available
forge_project_id string none available
last_action string none available
Choices
  • upload
  • download
Example: '"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
Example: '"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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested netfab integration cannot be found.

Returns info about cost for each line_item's process step

No description provided
Schema (application/json)
PropertyTypeDescription
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.


uri URI none available
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 total_cost and how each process step should be displayed in Order Quote document.


Example: '[{"operation": "printing|post-processing|shipping"}]'
Responses
Status CodeDescription
200

The request was successful

403

Unauthorized

404

RecordNotFound

Returns info about cost for each line_item's process step

No description provided
Schema (application/json)
PropertyTypeDescription
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.


uri URI none available
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 total_cost and how each process step should be displayed in Order Quote document.


Example: '[{"operation": "printing|post-processing|shipping"}]'
Responses
Status CodeDescription
200

The request was successful

403

Unauthorized

404

RecordNotFound

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)
PropertyTypeDescription
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
Example: '"pending|processing|complete|error"'
uri URI

The URI of the report.


user URI

The URI of the user making the report.


Responses
Status CodeDescription
200

The request was successful

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)
PropertyTypeDescription
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
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

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)
PropertyTypeDescription
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
Example: '"pending|processing|complete|error"'
uri URI

The URI of the report.


user URI

The URI of the user making the report.


Responses
Status CodeDescription
200

The request was successful

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)
PropertyTypeDescription
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: ('{"materials": {}, "estimator": ' '"authentise|shapeways|materialise|prosper|user"}')
layer_thickness float

The layer thickness of the print in mm. Must be < 1.


location URI

Location of attached order.


material URI

Not nested URI of base material for filtering.


material_name string

Name of material


materials object none available
Example: '{}'
model URL

The URI of the line-item's model.


name string

Human readable line-item name


no_model_upload boolean

flag to set that model shouldn't be uploaded


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.


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
Example: '"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
type string

Type of the Line Item


Choices
  • product
Example: '"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.


Responses
Status CodeDescription
200

The request was successful

404

The requested line-item cannot be found.

No description provided
Schema (application/json)
PropertyTypeDescription
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: ('{"materials": {}, "estimator": ' '"authentise|shapeways|materialise|prosper|user"}')
layer_thickness float

The layer thickness of the print in mm. Must be < 1.


Required
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
materials object none available
Required
Example: '{}'
model URL

The URI of the line-item's model.


Required
name string

Human readable line-item name


Required
no_model_upload boolean

flag to set that model shouldn't be uploaded


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
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
Example: '"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
type string

Type of the Line Item


Required
Choices
  • product
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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: ('{"materials": {}, "estimator": ' '"authentise|shapeways|materialise|prosper|user"}')
layer_thickness float

The layer thickness of the print in mm. Must be < 1.


location URI

Location of attached order.


material URI

Not nested URI of base material for filtering.


material_name string

Name of material


materials object none available
Example: '{}'
model URL

The URI of the line-item's model.


name string

Human readable line-item name


no_model_upload boolean

flag to set that model shouldn't be uploaded


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.


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
Example: '"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
type string

Type of the Line Item


Choices
  • product
Example: '"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.


Responses
Status CodeDescription
200

The request was successful

404

The requested line-item cannot be found.

/line-item/

get post

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.

Schema (application/json)
PropertyTypeDescription
autorun boolean

Enables automatic creation of runs for this line item.


bureau URI

The URI of bureau the line-item belongs to.


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.


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: ('{"materials": {}, "estimator": ' '"authentise|shapeways|materialise|prosper|user"}')
infill_strategy URI

Object infill type, as URI.


is_relevant_estimation boolean

flag to skip estimations


layer_thickness float

The layer thickness of the print in mm. Must be < 1.


materials object none available
Example: '{}'
model URI

The URI of the line-item's model.


model_unit string

The unit of measure for line-item's model.


name string

Human readable line-item name


no_model_upload boolean

flag to set that model shouldn't be uploaded


notes string

Notes for a line item.


order URI

The URI of order the line-item belongs to.


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


quantity integer

The number of objects to produce.


source_model_library URI

Source model library (if it will be/was created from model library) from which will be/was created line item.


status string

Status of an line-item.


Choices
  • new
  • calculating_estimates
  • pending
  • in-preparation
  • confirmed
  • printing
  • post-processing
  • shipping
  • error
  • cancelled
  • complete
Example: '"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
support_strategy URI

Object support type, as URI.


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
Example: '"product|specimen|waste|tooling"'
uri URI

The URI of the line-item.


workflow URI

The URI of workflow.


Responses
Status CodeDescription
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.

Create a new line_item.

Schema (application/json)
PropertyTypeDescription
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
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.


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: ('{"materials": {}, "estimator": ' '"authentise|shapeways|materialise|prosper|user"}')
infill_strategy URI

Object infill type, as URI.


Default: None
is_relevant_estimation boolean

flag to skip estimations


Default: True
layer_thickness float

The layer thickness of the print in mm. Must be < 1.


Default: 0.2
materials object none available
Required
Example: '{}'
model URI

The URI of the line-item's model.


Default: None
model_unit string

The unit of measure for line-item's model.


Default: None
name string

Human readable line-item name


Default: None
no_model_upload boolean

flag to set that model shouldn't be uploaded


Default: False
notes string

Notes for a line item.


Default: None
order URI

The URI of order the line-item belongs to.


Default: None
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
quantity integer

The number of objects to produce.


Required
source_model_library URI

Source model library (if it will be/was created from model library) from which will be/was created line item.


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
Example: '"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
support_strategy URI

Object support type, as URI.


Default: None
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
Example: '"product|specimen|waste|tooling"'
uri URI

The URI of the line-item.


Default: None
workflow URI

The URI of workflow.


Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
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.

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).
No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
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

No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
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)
PropertyTypeDescription
autorun boolean

Enables automatic creation of runs for this line item.


bureau URI

The URI of bureau the line-item belongs to.


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.


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: ('{"materials": {}, "estimator": ' '"authentise|shapeways|materialise|prosper|user"}')
infill_strategy URI

Object infill type, as URI.


is_relevant_estimation boolean

flag to skip estimations


layer_thickness float

The layer thickness of the print in mm. Must be < 1.


materials object none available
Example: '{}'
model URI

The URI of the line-item's model.


model_unit string

The unit of measure for line-item's model.


name string

Human readable line-item name


no_model_upload boolean

flag to set that model shouldn't be uploaded


notes string

Notes for a line item.


order URI

The URI of order the line-item belongs to.


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


quantity integer

The number of objects to produce.


source_model_library URI

Source model library (if it will be/was created from model library) from which will be/was created line item.


status string

Status of an line-item.


Choices
  • new
  • calculating_estimates
  • pending
  • in-preparation
  • confirmed
  • printing
  • post-processing
  • shipping
  • error
  • cancelled
  • complete
Example: '"new|calculating_estimates|pending|in-preparation|confirmed|printing|post-processing|shipping|error|cancelled|complete"'
support_strategy URI

Object support type, as URI.


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
Example: '"product|specimen|waste|tooling"'
uri URI

The URI of the line-item.


workflow URI

The URI of workflow.


Responses
Status CodeDescription
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.

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
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_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 CodeDescription
200

The request was successful

404

RecordNotFound: Location settings with passed UUID does not exist.

405

NotImplementedError

No description provided
Schema (application/json)
PropertyTypeDescription
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_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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

RecordNotFound: Location settings with passed UUID does not exist.

405

NotImplementedError

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

No description provided
Schema (application/json)
PropertyTypeDescription
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_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 CodeDescription
200

The request was successful

404

RecordNotFound: Location settings with passed UUID does not exist.

405

NotImplementedError

/location/

get post

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)
PropertyTypeDescription
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 CodeDescription
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.

country code is not ISO-3166 valid

403

You are not authorized to complete the request.

404

The requested location cannot be found.

Create a new location.

Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
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.

country code is not ISO-3166 valid

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)
PropertyTypeDescription
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 CodeDescription
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.

country code is not ISO-3166 valid

403

You are not authorized to complete the request.

404

The requested location cannot be found.

/manufacturer/

get post

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)
PropertyTypeDescription
address string

The address of the manufacturer.


base_template URI

Indicates the URI of Manufacture (from the shared library with is_template == True) from which this Manufacturer was created. If this field is not None - then users can not edit any fields.


bureau URI

The URI of the bureau for the manufacturer.


contact object

The user that will be the contact of the manufacturer.


Example: '{}'
is_template boolean

Indicates, that this Manufacturer was created as template (the shared library) object and can be used by all bureaus: can be copied to bureau level.


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 CodeDescription
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)
PropertyTypeDescription
address string

The address of the manufacturer.


Required
base_template URI

Indicates the URI of Manufacture (from the shared library with is_template == True) from which this Manufacturer was created. If this field is not None - then users can not edit any fields.


Required
bureau URI

The URI of the bureau for the manufacturer.


Required
contact object

The user that will be the contact of the manufacturer.


Required
Example: '{}'
is_template boolean

Indicates, that this Manufacturer was created as template (the shared library) object and can be used by all bureaus: can be copied to bureau level.


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
* These properties are required when POSTing
Responses
Status CodeDescription
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)
PropertyTypeDescription
address string

The address of the manufacturer.


base_template URI

Indicates the URI of Manufacture (from the shared library with is_template == True) from which this Manufacturer was created. If this field is not None - then users can not edit any fields.


bureau URI

The URI of the bureau for the manufacturer.


contact object

The user that will be the contact of the manufacturer.


Example: '{}'
is_template boolean

Indicates, that this Manufacturer was created as template (the shared library) object and can be used by all bureaus: can be copied to bureau level.


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 CodeDescription
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.

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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"'
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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

RecordNotFound

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:

  1. If there's source batch, get the source batch, and use the "units" in the source batch -- this logic is implemented in _dehydrate function
  2. 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)
PropertyTypeDescription
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
Example: '"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"'
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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

403

You are not authorized to complete the request.

404

RecordNotFound

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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"'
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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

RecordNotFound

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).

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

RecordNotFound

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).

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

RecordNotFound

The traceability report api is for exporting the events that transpired during the creation of a given object as a printable document.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"pending|processing|complete|error"'
uri URI

The URI of the report.


user URI

The URI of the user making the report.


Responses
Status CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested material batch report cannot be found.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"pending|processing|complete|error"'
uri URI

The URI of the report.


Default: None
user URI

The URI of the user making the report.


Required
* These properties are required when POSTing
Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"pending|processing|complete|error"'
uri URI

The URI of the report.


user URI

The URI of the user making the report.


Responses
Status CodeDescription
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/

get post

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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: '["..."]'
cost float

Cost associated with lot


Example: '"100.00"'
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 URI

URI of related material


material_in_containers boolean

True if this batch is still stored in containers, False if they are now mixed together in a bin


material_lot URI

URI of related material lot


material_name string

Name of material


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
Example: '"new|in_use|done"'
units string

Unit of material


Choices
  • cm3
  • mm3
  • inch3
  • gram
  • kg
  • lb
Example: '"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 CodeDescription
200

The request was successful

400

NotImplementedError

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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: '["..."]'
cost float

Cost associated with lot


Required
Example: '"100.00"'
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 URI

URI of related material


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_lot URI

URI of related material lot


Required
material_name string

Name of material


Required
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
Example: '"new|in_use|done"'
units string

Unit of material


Default: None
Choices
  • cm3
  • mm3
  • inch3
  • gram
  • kg
  • lb
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

400

NotImplementedError

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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: '["..."]'
cost float

Cost associated with lot


Example: '"100.00"'
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 URI

URI of related material


material_in_containers boolean

True if this batch is still stored in containers, False if they are now mixed together in a bin


material_lot URI

URI of related material lot


material_name string

Name of material


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
Example: '"new|in_use|done"'
units string

Unit of material


Choices
  • cm3
  • mm3
  • inch3
  • gram
  • kg
  • lb
Example: '"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 CodeDescription
200

The request was successful

400

NotImplementedError

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 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.

No description provided
Schema (application/json)
PropertyTypeDescription
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.


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
Example: '"new|in_use|empty"'
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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested material_container cannot be found.

No description provided
Schema (application/json)
PropertyTypeDescription
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
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
Example: '"new|in_use|empty"'
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: '["..."]'
* These properties are required when POSTing
Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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.


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
Example: '"new|in_use|empty"'
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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested material_container cannot be found.

Endpoint with slightly another implementation how another endpoints works.

Signature description is the same as for API /material-batch-linking/.

No description provided
Schema (application/json)
PropertyTypeDescription
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", ' '"metadata": null}]')
batches array none available
Example: ('[{"containers": ["..."], "cost": "100.00", "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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

405

MethodNotAllowed: Only GET method allowed for this endpoint.

No description provided
Schema (application/json)
PropertyTypeDescription
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", ' '"metadata": null}]')
batches array none available
Required
Example: ('[{"containers": ["..."], "cost": "100.00", "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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

403

You are not authorized to complete the request.

405

MethodNotAllowed: Only GET method allowed for this endpoint.

Endpoint with slightly another implementation how another endpoints works.

Signature description is the same as for API /material-batch-linking/.

No description provided
Schema (application/json)
PropertyTypeDescription
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", ' '"metadata": null}]')
batches array none available
Example: ('[{"containers": ["..."], "cost": "100.00", "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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

405

MethodNotAllowed: Only GET method allowed for this endpoint.

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

RecordNotFound

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

403

You are not authorized to complete the request.

404

RecordNotFound

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
Example: '"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 CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

RecordNotFound

/material-lot/

get post

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.

No description provided
Schema (application/json)
PropertyTypeDescription
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 integer

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
Example: '"on_order|received|in_testing|available|in_use|done|scrapped|return_to_supplier|in_storage"'
units string

Units of the material.


Choices
  • cm3
  • mm3
  • inch3
  • gram
  • kg
  • lb
Example: '"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 CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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 integer

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
Example: '"on_order|received|in_testing|available|in_use|done|scrapped|return_to_supplier|in_storage"'
units string

Units of the material.


Default: None
Choices
  • cm3
  • mm3
  • inch3
  • gram
  • kg
  • lb
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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 integer

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
Example: '"on_order|received|in_testing|available|in_use|done|scrapped|return_to_supplier|in_storage"'
units string

Units of the material.


Choices
  • cm3
  • mm3
  • inch3
  • gram
  • kg
  • lb
Example: '"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 CodeDescription
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 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.

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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
* These properties are required when POSTing
Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
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 CodeDescription
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/

get post

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)
PropertyTypeDescription
base_template URI

Indicates the URI of Material (from the shared library with is_template == True) from which this Material was created. If this field is not None - then users can not edit next fields: 'name', 'manufacturer', 'material_family'.


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'.


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 Material was created as template (the shared library) object and can be used by all bureaus: can be copied to bureau level.


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
Example: '"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL"'
material_family string

Class of the material by structure.


Choices
  • Polymer
  • Composite
  • Metal
  • Ceramic
  • Wax
  • Sand
Example: '"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
Example: '"True|False"'
thumbnail object none available
Example: '{}'
type string

Type of the material.


Choices
  • support
  • base
Example: '"support|base"'
units string

Unit of the stock, user-specified.


Choices
  • cm3
  • mm3
  • inch3
  • gram
  • kg
  • lb
Example: '"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
Example: '"weight|volume"'
uri URI none available
Responses
Status CodeDescription
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)
PropertyTypeDescription
base_template URI

Indicates the URI of Material (from the shared library with is_template == True) from which this Material was created. If this field is not None - then users can not edit next fields: 'name', 'manufacturer', 'material_family'.


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
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 Material was created as template (the shared library) object and can be used by all bureaus: can be copied to bureau level.


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
Example: '"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL"'
material_family string

Class of the material by structure.


Default: None
Choices
  • Polymer
  • Composite
  • Metal
  • Ceramic
  • Wax
  • Sand
Example: '"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
Example: '"True|False"'
thumbnail object none available
Default: None
Example: '{}'
type string

Type of the material.


Required
Choices
  • support
  • base
Example: '"support|base"'
units string

Unit of the stock, user-specified.


Default: cm3
Choices
  • cm3
  • mm3
  • inch3
  • gram
  • kg
  • lb
Example: '"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
Example: '"weight|volume"'
uri URI none available
Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
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.

Clone Material to the bureau level from the template (shared) Material

No description provided
Schema (application/json)
Responses
Status CodeDescription
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)
PropertyTypeDescription
base_template URI

Indicates the URI of Material (from the shared library with is_template == True) from which this Material was created. If this field is not None - then users can not edit next fields: 'name', 'manufacturer', 'material_family'.


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'.


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 Material was created as template (the shared library) object and can be used by all bureaus: can be copied to bureau level.


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
Example: '"Binder Jet|NA|SLA|SLS|FDM|Polyjet|Polyjet Anatomy|EBM|MJF|DLP|CLIP|DMLS|SDL"'
material_family string

Class of the material by structure.


Choices
  • Polymer
  • Composite
  • Metal
  • Ceramic
  • Wax
  • Sand
Example: '"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
Example: '"True|False"'
thumbnail object none available
Example: '{}'
type string

Type of the material.


Choices
  • support
  • base
Example: '"support|base"'
units string

Unit of the stock, user-specified.


Choices
  • cm3
  • mm3
  • inch3
  • gram
  • kg
  • lb
Example: '"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
Example: '"weight|volume"'
uri URI none available
Responses
Status CodeDescription
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/

get post

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.

No description provided
Schema (application/json)
PropertyTypeDescription
group URI none available
uri URI none available
user URI none available
Responses
Status CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
group URI none available
Required
uri URI none available
Default: None
user URI none available
Required
* These properties are required when POSTing
Responses
Status CodeDescription
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.

No description provided
Schema (application/json)
PropertyTypeDescription
group URI none available
uri URI none available
user URI none available
Responses
Status CodeDescription
200

The request was successful

/merge/

post

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

Create a new merge.

Schema (application/json)
PropertyTypeDescription
alt_model_formats array

Alternate merged model formats


Default: None
Example: '["..."]'
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: '{}'
created iso-8601 datetime

The time of creation of merge instance.


Default: None
description string

Description of merge model


Default: None
model URI

Merged run model URI


Default: None
models array none available
Default: None
Example: '[{"transformation": [["..."]]}]'
name string

Name of merge model.


Required
run_model_format string

Merged model format


Default: stl
uri URI

Merge URI


Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

The requested layout cannot be found.

This is a basic API endpoint wrapper, to extend a Flask View with extra features.

Get a single merge by uuid.

Schema (application/json)
PropertyTypeDescription
alt_model_formats array

Alternate merged model formats


Example: '["..."]'
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: '{}'
created iso-8601 datetime

The time of creation of merge instance.


description string

Description of merge model


model URI

Merged run model URI


models array none available
Example: '[{"transformation": [["..."]]}]'
name string

Name of merge model.


run_model_format string

Merged model format


uri URI

Merge URI


Responses
Status CodeDescription
200

The request was successful

404

The requested layout cannot be found.

/model-library/

get post

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.

No description provided
Schema (application/json)
PropertyTypeDescription
base_material URI

The URI of base material.


created iso-8601 datetime

The date when the Model Library was created.


labels array

list of label uris related to the model-library


Example: '["..."]'
layer_thickness float

The layer thickness of the print in mm. Must be < 1.


model URI

This URL should point to a valid model resource that has already been uploaded.


name string

The name of the model library.


notes string

The description of the Model Library.


source_line_item URI

Source line item (if it will be/was created from line item) from which will be/was created model library.


support_material URI

The URI of support material.


type string

specimen represent model-libraries for specimens; product represent model-libraries for line-items.


Choices
  • product
  • specimen
  • waste
  • tooling
Example: '"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 CodeDescription
200

The request was successful

403

Unauthorized: You do not have the necessary model_library permissions to complete the request.

404

RecordNotFound

No description provided
Schema (application/json)
PropertyTypeDescription
base_material URI

The URI of base material.


Default: None
created iso-8601 datetime

The date when the Model Library was created.


Default: None
labels array

list of label uris related to the model-library


Default: []
Example: '["..."]'
layer_thickness float

The layer thickness of the print in mm. Must be < 1.


Default: None
model URI

This URL should point to a valid model resource that has already been uploaded.


Required
name string

The name of the model library.


Required
notes string

The description of the Model Library.


Default: None
source_line_item URI

Source line item (if it will be/was created from line item) from which will be/was created model library.


Required
support_material URI

The URI of support material.


Default: None
type string

specimen represent model-libraries for specimens; product represent model-libraries for line-items.


Required
Choices
  • product
  • specimen
  • waste
  • tooling
Example: '"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
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

403

Unauthorized: You do not have the necessary model_library permissions to complete the request.

404

RecordNotFound

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.

No description provided
Schema (application/json)
PropertyTypeDescription
base_material URI

The URI of base material.


created iso-8601 datetime

The date when the Model Library was created.


labels array

list of label uris related to the model-library


Example: '["..."]'
layer_thickness float

The layer thickness of the print in mm. Must be < 1.


model URI

This URL should point to a valid model resource that has already been uploaded.


name string

The name of the model library.


notes string

The description of the Model Library.


source_line_item URI

Source line item (if it will be/was created from line item) from which will be/was created model library.


support_material URI

The URI of support material.


type string

specimen represent model-libraries for specimens; product represent model-libraries for line-items.


Choices
  • product
  • specimen
  • waste
  • tooling
Example: '"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