Reference

Gather template list of work checklists for line item or process step. Template endpoint separated from WorkChecklistLinking/WorkChecklistsFor - because template will be collected during the execution of the request (and related from the current state of the line item and process step work checklists) but when WorkChecklistLinking/WorkChecklistsFor representing state on creation/editing moment.

Get a set of work checklists (work checklists linkings with work checklists ) based on a UUID and which table they relate to.

This will build work_checklists from parent objects in the order of::

  • A checklist for workflows (workflow itself if related_resource == 'workflow or for line_item's workflow if related_resource == 'line-item') and if some process steps of the workflow have no related checklists - they will be infilled with draft templates (cls.__build_template_linking)

  • A checklist from the $WORK_type of each process_step in the workflow (if related_resource == 'workflow or if elated_resource == 'line-item but it's workflow have no checklists yet.)

Schema (application/json)
PropertyTypeDescription
Responses
Status CodeDescription
200

The request was successful

404

The requested object cannot be found.

/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
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 bacsic 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 bacsic 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 URL

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 URL

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 URL

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
allowed_transformations object none available
Example: '{}'
analyses object none available
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
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
rights array none available
Example: '["all|download|print|transform|transform-external|view"]'
size object none available
Example: '{}'
snapshot string none available
snapshot_content string none available
status string none available
Choices
  • not-uploaded
  • processing
  • processed
  • external-process
  • error
  • inoperable
Example: '"not-uploaded|processing|processed|external-process|error|inoperable"'
surface_area_mm float none available
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"'
unit string

The Unit of Measure for models (mm or in)


Choices
  • in
  • mm
Example: '"in|mm"'
updated iso-8601 datetime none available
upload-location string none available
uri URI none available
user_uri string none available
versions array

List of Asset-Versions tied to a particular Asset


Example: '["..."]'
volume_mm float none available
Responses
Status CodeDescription
200

The request was successful

404

generated-exception-class raised

Create a new asset.

Schema (application/json)
PropertyTypeDescription
allowed_transformations object none available
Default: {'resize': False, 'rotation': False}
Example: '{}'
analyses object none available
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
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
rights array none available
Default: None
Example: '["all|download|print|transform|transform-external|view"]'
size object none available
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
  • inoperable
Example: '"not-uploaded|processing|processed|external-process|error|inoperable"'
surface_area_mm float none available
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"'
unit string

The Unit of Measure for models (mm or in)


Default: mm
Choices
  • in
  • mm
Example: '"in|mm"'
updated iso-8601 datetime none available
Default: None
upload-location string none available
Default: None
uri URI none available
Default: None
user_uri string none available
Default: None
versions array

List of Asset-Versions tied to a particular Asset


Default: None
Example: '["..."]'
volume_mm float none available
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
allowed_transformations object none available
Example: '{}'
analyses object none available
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
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
rights array none available
Example: '["all|download|print|transform|transform-external|view"]'
size object none available
Example: '{}'
snapshot string none available
snapshot_content string none available
status string none available
Choices
  • not-uploaded
  • processing
  • processed
  • external-process
  • error
  • inoperable
Example: '"not-uploaded|processing|processed|external-process|error|inoperable"'
surface_area_mm float none available
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"'
unit string

The Unit of Measure for models (mm or in)


Choices
  • in
  • mm
Example: '"in|mm"'
updated iso-8601 datetime none available
upload-location string none available
uri URI none available
user_uri string none available
versions array

List of Asset-Versions tied to a particular Asset


Example: '["..."]'
volume_mm float none available
Responses
Status CodeDescription
200

The request was successful

404

generated-exception-class raised

/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


layers integer

The number of layers in this build


modeler URI

The URI of the printer performing the build


name string

The name of the build as determined by the printer


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
layers integer

The number of layers in this build


Required
modeler URI

The URI of the printer performing the build


Required
name string

The name of the build as determined by the printer


Required
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


layers integer

The number of layers in this build


modeler URI

The URI of the printer performing the build


name string

The name of the build as determined by the printer


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 bacsic 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_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_email string

Custom email address to which the notification should be sent


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"'
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 bacsic 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_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_email string

Custom email address to which the notification should be sent


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

This resource exists to return a list of business segment values

Flat list of typees. DOES NOT MATCH STANDARD LIST ENDPOINT PATTERN

Schema (application/json)
Responses
Status CodeDescription
200

The request was successful

404

RecordNotFound

RecordNotFound

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

The request was successful

404

RecordNotFound

RecordNotFound

This resource exists to return a list of business segment values

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

The request was successful

404

RecordNotFound

RecordNotFound

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

No description provided
Schema (application/json)
PropertyTypeDescription
business_segment URI none available
name string none available
uri URI none available
Responses
Status CodeDescription
200

The request was successful

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

No description provided
Schema (application/json)
PropertyTypeDescription
business_segment URI none available
name string none available
uri URI none available
Responses
Status CodeDescription
200

The request was successful

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

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

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


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


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 string

The URI of the user making the capture


Responses
Status CodeDescription
200

The request was successful

404

RecordNotFound raised

Create a new capture

Schema (application/json)
PropertyTypeDescription
capture_type URI

The URI of the capture-type this capture uses


Required
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
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 string

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

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


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


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 string

The URI of the user making the capture


Responses
Status CodeDescription
200

The request was successful

404

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

/config/

get post

This is a bacsic 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 bacsic 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 bacsic 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 bacsic 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 bacsic 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

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

The URI of the bureau for which we have the currency-conversion value.


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

404

The requested currency-conversion cannot be found.

Create a new currency conversion.

Schema (application/json)
PropertyTypeDescription
bureau URI

The URI of the bureau for which we have the currency-conversion value.


Required
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"'
uri URI

The URI for currency conversion.


Default: None
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.

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

The URI of the bureau for which we have the currency-conversion value.


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

404

The requested currency-conversion cannot be found.

This is a bacsic 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 bacsic 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

Readonly endpoint for CustomField records. These are per-customer paid changes they need to run their system. See file design/Custom_Fields.md for the design of the system.

No description provided
Schema (application/json)
PropertyTypeDescription
enabled boolean

Is field disabled or not


field_id string

String human readable ID of custom field.


field_name string

Name of custom field.


options array

Array with possible options of custom field.


Example: '[{}]'
position integer

Represents position of custom field in the rendered fields block.


related_table_name string

Table with which the value is associated.


required boolean

Is field required or not


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

Readonly endpoint for CustomField records. These are per-customer paid changes they need to run their system. See file design/Custom_Fields.md for the design of the system.

No description provided
Schema (application/json)
PropertyTypeDescription
enabled boolean

Is field disabled or not


field_id string

String human readable ID of custom field.


field_name string

Name of custom field.


options array

Array with possible options of custom field.


Example: '[{}]'
position integer

Represents position of custom field in the rendered fields block.


related_table_name string

Table with which the value is associated.


required boolean

Is field required or not


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

Create a document for an Order, a Run or a Line Item.

This endpoint is used for attaching a document to an order, a run or a line_item. Users can attach documents, such as drawings or images, that help describe and provide information pertaining to an order, a run or a line_item.

After a new document is created, a X-Upload-Location header will be returned. Use the X-Upload-location header to PUT file contents to that location.

List all documents.

Schema (application/json)
PropertyTypeDescription
content string

The URL of the document if one has been uploaded.


name string

The name of the document.


related_table_name string

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


Choices
  • line_item
  • order
  • run
  • work_instruction_report
  • material
Example: '"line_item|order|run|work_instruction_report|material"'
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.


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
content string

The URL of the document if one has been uploaded.


Default: None
name string

The name of the document.


Default: None
related_table_name string

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


Required
Choices
  • line_item
  • order
  • run
  • work_instruction_report
  • material
Example: '"line_item|order|run|work_instruction_report|material"'
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.


Default: None
uri URI

The URI of the document.


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 document cannot be found.

Create a document for an Order, a Run or a Line Item.

This endpoint is used for attaching a document to an order, a run or a line_item. Users can attach documents, such as drawings or images, that help describe and provide information pertaining to an order, a run or a line_item.

After a new document is created, a X-Upload-Location header will be returned. Use the X-Upload-location header to PUT file contents to that location.

Get an document by UUID.

Schema (application/json)
PropertyTypeDescription
content string

The URL of the document if one has been uploaded.


name string

The name of the document.


related_table_name string

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


Choices
  • line_item
  • order
  • run
  • work_instruction_report
  • material
Example: '"line_item|order|run|work_instruction_report|material"'
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.


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


user string

The URI of the user creating downtime.


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
user string

The URI of the user creating downtime.


Required
* 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 perticular 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.


user string

The URI of the user creating downtime.


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 bacsic 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 resourcce that changed


uri URI

The URI of the event.


user string

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 resourcce that changed


uri URI

The URI of the event.


user string

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 URL

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 URL

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
  • itar
  • 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
  • third-party-providers
  • manufacturing-execution-system
  • machine-analytics
  • external_production_estimate
  • recalculation_trigger
  • qr-prints-traveler
  • order-offer
  • order-offer-special-processing
  • user-can-update-estimates
  • model-unit-default-mm
  • specimen-library
  • auto-schedule-runs
  • use_100_infill
  • autorun
  • autologout
  • external-material-db
Example: '"ip-sensitivity|itar|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|third-party-providers|manufacturing-execution-system|machine-analytics|external_production_estimate|recalculation_trigger|qr-prints-traveler|order-offer|order-offer-special-processing|user-can-update-estimates|model-unit-default-mm|specimen-library|auto-schedule-runs|use_100_infill|autorun|autologout|external-material-db"'
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
  • itar
  • 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
  • third-party-providers
  • manufacturing-execution-system
  • machine-analytics
  • external_production_estimate
  • recalculation_trigger
  • qr-prints-traveler
  • order-offer
  • order-offer-special-processing
  • user-can-update-estimates
  • model-unit-default-mm
  • specimen-library
  • auto-schedule-runs
  • use_100_infill
  • autorun
  • autologout
  • external-material-db
Example: '"ip-sensitivity|itar|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|third-party-providers|manufacturing-execution-system|machine-analytics|external_production_estimate|recalculation_trigger|qr-prints-traveler|order-offer|order-offer-special-processing|user-can-update-estimates|model-unit-default-mm|specimen-library|auto-schedule-runs|use_100_infill|autorun|autologout|external-material-db"'
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
  • itar
  • 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
  • third-party-providers
  • manufacturing-execution-system
  • machine-analytics
  • external_production_estimate
  • recalculation_trigger
  • qr-prints-traveler
  • order-offer
  • order-offer-special-processing
  • user-can-update-estimates
  • model-unit-default-mm
  • specimen-library
  • auto-schedule-runs
  • use_100_infill
  • autorun
  • autologout
  • external-material-db
Example: '"ip-sensitivity|itar|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|third-party-providers|manufacturing-execution-system|machine-analytics|external_production_estimate|recalculation_trigger|qr-prints-traveler|order-offer|order-offer-special-processing|user-can-update-estimates|model-unit-default-mm|specimen-library|auto-schedule-runs|use_100_infill|autorun|autologout|external-material-db"'
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
base_material URI

The URI of base material.


design_time integer

Time which can take bureau for design review in seconds.


layer_thickness float

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


model URL

The URI for model.


model_name string

The unit of measure for 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.


notes string

Notes for a line item.


prints_quantity integer

Prints Quantity.


status string

Status of an line-item.


uri URI

The URI of the line-item.


uuid uuid

The UUID of the line-item.


Choices
  • o
  • r
  • d
  • e
  • r
Example: '"o|r|d|e|r"'
workflow URI

The URI of workflow.


Responses
Status CodeDescription
200

The request was successful

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

The URI of base material.


Required
design_time integer

Time which can take bureau for design review in seconds.


Default: None
layer_thickness float

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


Required
model URL

The URI for model.


Default: None
model_name string

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


Default: None
model_render URL

The URI for line-item's render model.


Default: None
model_surface_area float

Model surface area.


Default: None
model_updated iso-8601 datetime

When the model was last updated.


Default: None
model_volume float

Model volume.


Default: None
notes string

Notes for a line item.


Default: None
prints_quantity integer

Prints Quantity.


Required
status string

Status of an line-item.


Default: None
uri URI

The URI of the line-item.


Default: None
uuid uuid

The UUID of the line-item.


Default: None
Choices
  • o
  • r
  • d
  • e
  • r
Example: '"o|r|d|e|r"'
workflow URI

The URI of workflow.


Default: None
* 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
base_material URI

The URI of base material.


design_time integer

Time which can take bureau for design review in seconds.


layer_thickness float

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


model URL

The URI for model.


model_name string

The unit of measure for 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.


notes string

Notes for a line item.


prints_quantity integer

Prints Quantity.


status string

Status of an line-item.


uri URI

The URI of the line-item.


uuid uuid

The UUID of the line-item.


Choices
  • o
  • r
  • d
  • e
  • r
Example: '"o|r|d|e|r"'
workflow URI

The URI of workflow.


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
application_type string

Application Type.


bureau_costs float

Estimated bureau costs.


business_segment string

Business segment.


business_unit URI

The URI of the business unit.


created iso-8601 datetime

The date the order was created.


customer_email string

Customer email address.


customer_name string

Customer name for the order.


due_date iso-8601 datetime

The due date for the order.


ip_sensitivity string

The intellectual property sensitivity.


line_items_quantity integer

Line Item Quantity.


location URI

URI of the location


name string

Name of the order.


notes string

Notes for the order.


offer_approved boolean

Is order offer accepted


offer_created_at string

The URI of the order owner.


offer_customer_po string

PO for order offer.


offer_discount float

Discount for order


offer_uri string

The URI of the order owner.


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 URI of the order owner.


prints_quantity integer

Prints Quantity.


shipping_address string

Shipping address.


shipping_name string

Shipping name.


status string

Status of an order.


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
application_type string

Application Type.


Default: None
bureau_costs float

Estimated bureau costs.


Default: None
business_segment string

Business segment.


Default: None
business_unit URI

The URI of the business unit.


Default: None
created iso-8601 datetime

The date the order was created.


Default: None
customer_email string

Customer email address.


Default: None
customer_name string

Customer name for the order.


Default: None
due_date iso-8601 datetime

The due date for the order.


Default: None
ip_sensitivity string

The intellectual property sensitivity.


Default: None
line_items_quantity integer

Line Item Quantity.


Required
location URI

URI of the location


Default: None
name string

Name of the order.


Required
notes string

Notes for the order.


Default: None
offer_approved boolean

Is order offer accepted


Default: None
offer_created_at string

The URI of the order owner.


Default: None
offer_customer_po string

PO for order offer.


Default: None
offer_discount float

Discount for order


Default: None
offer_uri string

The URI of the order owner.


Default: None
order_type string

Order type choices. Choice depends on the bureau.


Default: None
order_volume integer

Order volume.


Default: None
owner_email string

Email of the order owner.


Default: None
owner_name string

The URI of the order owner.


Default: None
prints_quantity integer

Prints Quantity.


Required
shipping_address string

Shipping address.


Default: None
shipping_name string

Shipping name.


Default: None
status string

Status of an order.


Required
uri URI

The URI of the order.


Default: None
uuid uuid

The UUID of the order.


Default: None
* 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
application_type string

Application Type.


bureau_costs float

Estimated bureau costs.


business_segment string

Business segment.


business_unit URI

The URI of the business unit.


created iso-8601 datetime

The date the order was created.


customer_email string

Customer email address.


customer_name string

Customer name for the order.


due_date iso-8601 datetime

The due date for the order.


ip_sensitivity string

The intellectual property sensitivity.


line_items_quantity integer

Line Item Quantity.


location URI

URI of the location


name string

Name of the order.


notes string

Notes for the order.


offer_approved boolean

Is order offer accepted


offer_created_at string

The URI of the order owner.


offer_customer_po string

PO for order offer.


offer_discount float

Discount for order


offer_uri string

The URI of the order owner.


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 URI of the order owner.


prints_quantity integer

Prints Quantity.


shipping_address string

Shipping address.


shipping_name string

Shipping name.


status string

Status of an order.


uri URI

The URI of the order.


uuid uuid

The UUID of the order.


Responses
Status CodeDescription
200

The request was successful

/gcode/

get post

This is a bacsic 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

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

This is a bacsic 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

/groups/

get post

This is a bacsic 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 bacsic 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

/identities/

get post

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

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

The request was successful

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

No description provided
Schema (application/json)
PropertyTypeDescription
group URI none available
identity string none available
uri URI none available
user URI 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 bacsic 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

/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: '{}'
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 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"'
* 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: '{}'
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 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"'
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 is a bacsic 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 bacsic 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.

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 string

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 string

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 string

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.

LineItemThirdParty resource will connect LineItem and ThirdParty resources and will provide additional data for there endpoints

Get all resources for your account.

Schema (application/json)
PropertyTypeDescription
cost float

The cost of LineItemThirdParty


due_at iso-8601 datetime

Due at date


line_item URI

The URI for line-item resource.


order URI

The URI of order the line-item belongs to.


status string

Status of LineItemThirdParty


Choices
  • created
  • requested_bid
  • saved_bid_data
  • confirmed
  • complete
  • cancelled
Example: '"created|requested_bid|saved_bid_data|confirmed|complete|cancelled"'
third_party URI

The URI for third-party resource.


uri URI

The URI for resource.


Responses
Status CodeDescription
200

The request was successful

400

The requested LineItemThirdParty name already exists.

404

The requested LineItemThirdParty cannot be found.

LineItemThirdParty resource will connect LineItem and ThirdParty resources and will provide additional data for there endpoints

Get an individual LineItemThirdParty resource by UUID.

Schema (application/json)
PropertyTypeDescription
cost float

The cost of LineItemThirdParty


due_at iso-8601 datetime

Due at date


line_item URI

The URI for line-item resource.


order URI

The URI of order the line-item belongs to.


status string

Status of LineItemThirdParty


Choices
  • created
  • requested_bid
  • saved_bid_data
  • confirmed
  • complete
  • cancelled
Example: '"created|requested_bid|saved_bid_data|confirmed|complete|cancelled"'
third_party URI

The URI for third-party resource.


uri URI

The URI for resource.


Responses
Status CodeDescription
200

The request was successful

400

The requested LineItemThirdParty name already exists.

404

The requested LineItemThirdParty 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: '[{}]'
design_time integer

Time which can take bureau for design review in seconds.


error string none available
estimates object none available
Example: '{"materials": {}, "estimator": "materialise|shapeways|prosper|authentise"}'
infill_strategy URI

Object infill type, as URI.


is_relevant_estimation boolean

flag to skip estimations


itar boolean

flag to set to conform with ITAR


layer_thickness float

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


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

The URI of the line-item's model.


model_unit string

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


notes string

Notes for a line item.


order URI

The URI of order the line-item belongs to.


quantity integer

The number of objects to produce.


status string

Status of an line-item.


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

Object support type, as URI.


third_party_provider URI

Legacy field. Do not use.


type string

Type of the Line Item


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 itar to True. You cannot do both, and you cannot do neither.

An line-item with active prints cannot be deleted

Provided status transformation is not allowed

Template is required for the line-item.

If an order offer are enabled, the parent order's offer 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: '[{}]'
design_time integer

Time which can take bureau for design review in seconds.


Default: None
error string none available
Default: None
estimates object none available
Default: None
Example: '{"materials": {}, "estimator": "materialise|shapeways|prosper|authentise"}'
infill_strategy URI

Object infill type, as URI.


Default: None
is_relevant_estimation boolean

flag to skip estimations


Default: True
itar boolean

flag to set to conform with ITAR


Default: False
layer_thickness float

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


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

The URI of the line-item's model.


Default: None
model_unit string

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


Default: None
notes string

Notes for a line item.


Default: None
order URI

The URI of order the line-item belongs to.


Default: None
quantity integer

The number of objects to produce.


Required
status string

Status of an line-item.


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

Object support type, as URI.


Default: None
third_party_provider URI

Legacy field. Do not use.


Default: None
type string

Type of the Line Item


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 itar to True. You cannot do both, and you cannot do neither.

An line-item with active prints cannot be deleted

Provided status transformation is not allowed

Template is required for the line-item.

If an order offer are enabled, the parent order's offer 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 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: '[{}]'
design_time integer

Time which can take bureau for design review in seconds.


error string none available
estimates object none available
Example: '{"materials": {}, "estimator": "materialise|shapeways|prosper|authentise"}'
infill_strategy URI

Object infill type, as URI.


is_relevant_estimation boolean

flag to skip estimations


itar boolean

flag to set to conform with ITAR


layer_thickness float

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


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

The URI of the line-item's model.


model_unit string

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


notes string

Notes for a line item.


order URI

The URI of order the line-item belongs to.


quantity integer

The number of objects to produce.


status string

Status of an line-item.


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

Object support type, as URI.


third_party_provider URI

Legacy field. Do not use.


type string

Type of the Line Item


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 itar to True. You cannot do both, and you cannot do neither.

An line-item with active prints cannot be deleted

Provided status transformation is not allowed

Template is required for the line-item.

If an order offer are enabled, the parent order's offer 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.

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


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


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.

/material/

get post

A material resource represents some kind of product that can be used to create digitally manufactured goods. This includes thermoplastics, metal powders, foundry sand, etc. Any material that may be used to produce parts. The material resource is then used to identify capabilities that printers have as well as allow users to define what material they would like their finished products to be made from.

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


bureau URI

The URI of the material's bureau.


color string

HEX Color of the material. Example: (#000000)


cost float

The cost of the material per cc.


description string

The description of the material


external_datasheet_url URL

URL on remote documentation about material.


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
  • Material Extrusion
  • Vat Photopolymerization
  • Powder Bed Fusion
  • Material Jetting
  • Binder Jetting
  • Directed Energy Deposition
  • Sheet Lamination
Example: ('"Material Extrusion|Vat Photopolymerization|Powder Bed Fusion|Material ' 'Jetting|Binder Jetting|Directed Energy Deposition|Sheet Lamination"')
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.


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.


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


Required
bureau URI

The URI of the material's bureau.


Required
color string

HEX Color of the material. Example: (#000000)


Required
cost float

The cost of the material per cc.


Required
description string

The description of the material


Required
external_datasheet_url URL

URL on remote documentation about material.


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
  • Material Extrusion
  • Vat Photopolymerization
  • Powder Bed Fusion
  • Material Jetting
  • Binder Jetting
  • Directed Energy Deposition
  • Sheet Lamination
Example: ('"Material Extrusion|Vat Photopolymerization|Powder Bed Fusion|Material ' 'Jetting|Binder Jetting|Directed Energy Deposition|Sheet Lamination"')
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
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.


Default: cm3
Choices
  • grams
  • cm3
Example: '"grams|cm3"'
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 resource represents some kind of product that can be used to create digitally manufactured goods. This includes thermoplastics, metal powders, foundry sand, etc. Any material that may be used to produce parts. The material resource is then used to identify capabilities that printers have as well as allow users to define what material they would like their finished products to be made from.

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


bureau URI

The URI of the material's bureau.


color string

HEX Color of the material. Example: (#000000)


cost float

The cost of the material per cc.


description string

The description of the material


external_datasheet_url URL

URL on remote documentation about material.


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
  • Material Extrusion
  • Vat Photopolymerization
  • Powder Bed Fusion
  • Material Jetting
  • Binder Jetting
  • Directed Energy Deposition
  • Sheet Lamination
Example: ('"Material Extrusion|Vat Photopolymerization|Powder Bed Fusion|Material ' 'Jetting|Binder Jetting|Directed Energy Deposition|Sheet Lamination"')
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.


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.


Choices
  • grams
  • cm3
Example: '"grams|cm3"'
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 a bacsic API endpoint wrapper, to extend a Flask View with extra features.

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 a bacsic API endpoint wrapper, to extend a Flask View with extra features.

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 bacsic 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 bacsic 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
created iso-8601 datetime

The date when the Model Library was created.


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.


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.


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
created iso-8601 datetime

The date when the Model Library was created.


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
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
* 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
created iso-8601 datetime

The date when the Model Library was created.


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.


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.


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

/model/

get post

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

No description provided
Schema (application/json)
PropertyTypeDescription
allowed_transformations object none available
Example: '{}'
analyses object none available
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
file_size integer none available
name string

name of the model. Cannot exceed 255 characters.


parents array none available
Example: '["..."]'
polygons integer none available
rights array none available
Example: '["all|download|print|transform|transform-external|view"]'
size object none available
Example: '{}'
snapshot string none available
snapshot_content string none available
status string none available
Choices
  • not-uploaded
  • processing
  • processed
  • external-process
  • error
  • inoperable
Example: '"not-uploaded|processing|processed|external-process|error|inoperable"'
surface_area_mm float none available
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"'
unit string

The Unit of Measure for models (mm or in)


Choices
  • in
  • mm
Example: '"in|mm"'
updated iso-8601 datetime none available
upload-location string none available
uri URI none available
user_uri string none available
volume_mm float none available
Responses
Status CodeDescription
200

The request was successful

401

no-model-rights: You do not have any rights on this model

create a new model NOTE: Most 'model' updates should be done by creating a new model. See docs.authentise.com or PlatformModel code for more details.

Schema (application/json)
PropertyTypeDescription
allowed_transformations object none available
Default: {'resize': False, 'rotation': False}
Example: '{}'
analyses object none available
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
file_size integer none available
Default: None
name string

name of the model. Cannot exceed 255 characters.


Required
parents array none available
Default: []
Example: '["..."]'
polygons integer none available
Default: None
rights array none available
Default: None
Example: '["all|download|print|transform|transform-external|view"]'
size object none available
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
  • inoperable
Example: '"not-uploaded|processing|processed|external-process|error|inoperable"'
surface_area_mm float none available
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"'
unit string

The Unit of Measure for models (mm or in)


Default: mm
Choices
  • in
  • mm
Example: '"in|mm"'
updated iso-8601 datetime none available
Default: None
upload-location string none available
Default: None
uri URI none available
Default: None
user_uri string none available
Default: None
volume_mm float none available
Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

401

no-model-rights: You do not have any rights on this model

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

No description provided
Schema (application/json)
PropertyTypeDescription
callback object none available
Example: '{"method": "GET|POST|PUT"}'
color string none available
content string none available
created iso-8601 datetime none available
height integer none available
model URI none available
samples integer none available
slice_height float none available
status string none available
Choices
  • model_not-uploaded
  • model_processing
  • model_error
  • model_inoperable
  • model_external-process
  • snapshot_in_queue
  • snapshot_rendering
  • snapshot_error
  • snapshot_rendered
Example: '"model_not-uploaded|model_processing|model_error|model_inoperable|model_external-process|snapshot_in_queue|snapshot_rendering|snapshot_error|snapshot_rendered"'
u float none available
uri URI none available
v float none available
w float none available
width integer none available
x float none available
y float none available
z float none available
Responses
Status CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
callback object none available
Default: None
Example: '{"method": "GET|POST|PUT"}'
color string none available
Default: #FF7F00
content string none available
Default: None
created iso-8601 datetime none available
Default: None
height integer none available
Default: 480
model URI none available
Default: None
samples integer none available
Default: 10
slice_height float none available
Default: None
status string none available
Default: None
Choices
  • model_not-uploaded
  • model_processing
  • model_error
  • model_inoperable
  • model_external-process
  • snapshot_in_queue
  • snapshot_rendering
  • snapshot_error
  • snapshot_rendered
Example: '"model_not-uploaded|model_processing|model_error|model_inoperable|model_external-process|snapshot_in_queue|snapshot_rendering|snapshot_error|snapshot_rendered"'
u float none available
Default: None
uri URI none available
Default: None
v float none available
Default: None
w float none available
Default: None
width integer none available
Default: 640
x float none available
Default: None
y float none available
Default: None
z float none available
Default: None
Responses
Status CodeDescription
204

The request was successful

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

No description provided
Schema (application/json)
PropertyTypeDescription
callback object none available
Example: '{"method": "GET|POST|PUT"}'
color string none available
content string none available
created iso-8601 datetime none available
height integer none available
model URI none available
samples integer none available
slice_height float none available
status string none available
Choices
  • model_not-uploaded
  • model_processing
  • model_error
  • model_inoperable
  • model_external-process
  • snapshot_in_queue
  • snapshot_rendering
  • snapshot_error
  • snapshot_rendered
Example: '"model_not-uploaded|model_processing|model_error|model_inoperable|model_external-process|snapshot_in_queue|snapshot_rendering|snapshot_error|snapshot_rendered"'
u float none available
uri URI none available
v float none available
w float none available
width integer none available
x float none available
y float none available
z float none available
Responses
Status CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
callback object none available
Default: None
Example: '{"method": "GET|POST|PUT"}'
color string none available
Default: #FF7F00
content string none available
Default: None
created iso-8601 datetime none available
Default: None
height integer none available
Default: 480
model URI none available
Default: None
samples integer none available
Default: 10
slice_height float none available
Default: None
status string none available
Default: None
Choices
  • model_not-uploaded
  • model_processing
  • model_error
  • model_inoperable
  • model_external-process
  • snapshot_in_queue
  • snapshot_rendering
  • snapshot_error
  • snapshot_rendered
Example: '"model_not-uploaded|model_processing|model_error|model_inoperable|model_external-process|snapshot_in_queue|snapshot_rendering|snapshot_error|snapshot_rendered"'
u float none available
Default: None
uri URI none available
Default: None
v float none available
Default: None
w float none available
Default: None
width integer none available
Default: 640
x float none available
Default: None
y float none available
Default: None
z float none available
Default: None
Responses
Status CodeDescription
204

The request was successful

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

No description provided
Schema (application/json)
PropertyTypeDescription
callback object none available
Example: '{"method": "GET|POST|PUT"}'
color string none available
content string none available
created iso-8601 datetime none available
height integer none available
model URI none available
samples integer none available
slice_height float none available
status string none available
Choices
  • model_not-uploaded
  • model_processing
  • model_error
  • model_inoperable
  • model_external-process
  • snapshot_in_queue
  • snapshot_rendering
  • snapshot_error
  • snapshot_rendered
Example: '"model_not-uploaded|model_processing|model_error|model_inoperable|model_external-process|snapshot_in_queue|snapshot_rendering|snapshot_error|snapshot_rendered"'
u float none available
uri URI none available
v float none available
w float none available
width integer none available
x float none available
y float none available
z float none available
Responses
Status CodeDescription
200

The request was successful

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

No description provided
Schema (application/json)
PropertyTypeDescription
callback object none available
Example: '{"method": "GET|POST|PUT"}'
color string none available
content string none available
created iso-8601 datetime none available
height integer none available
model URI none available
samples integer none available
slice_height float none available
status string none available
Choices
  • model_not-uploaded
  • model_processing
  • model_error
  • model_inoperable
  • model_external-process
  • snapshot_in_queue
  • snapshot_rendering
  • snapshot_error
  • snapshot_rendered
Example: '"model_not-uploaded|model_processing|model_error|model_inoperable|model_external-process|snapshot_in_queue|snapshot_rendering|snapshot_error|snapshot_rendered"'
u float none available
uri URI none available
v float none available
w float none available
width integer none available
x float none available
y float none available
z float none available
Responses
Status CodeDescription
200

The request was successful

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

Creat a new model

Schema (application/json)
PropertyTypeDescription
Responses
Status CodeDescription
204

The request was successful

400

invalid-payload

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

No description provided
Schema (application/json)
PropertyTypeDescription
allowed_transformations object none available
Example: '{}'
analyses object none available
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
file_size integer none available
name string

name of the model. Cannot exceed 255 characters.


parents array none available
Example: '["..."]'
polygons integer none available
rights array none available
Example: '["all|download|print|transform|transform-external|view"]'
size object none available
Example: '{}'
snapshot string none available
snapshot_content string none available
status string none available
Choices
  • not-uploaded
  • processing
  • processed
  • external-process
  • error
  • inoperable
Example: '"not-uploaded|processing|processed|external-process|error|inoperable"'
surface_area_mm float none available
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"'
unit string

The Unit of Measure for models (mm or in)


Choices
  • in
  • mm
Example: '"in|mm"'
updated iso-8601 datetime none available
upload-location string none available
uri URI none available
user_uri string none available
volume_mm float none available
Responses
Status CodeDescription
200

The request was successful

401

no-model-rights: You do not have any rights on this model

Get information about the different supported modeler-types (printer models)

Get list of modeler-types. Supports filters

Schema (application/json)
PropertyTypeDescription
capture_types array

The capture_types associated with this modeler-type


Example: ('[{"capture_type": ' '"arcam.job.log|carbon3D.modeler.status|catex.modeler.jobs|catex.modeler.status|connex.modeler.log|eos.modeler.log|hp.modeler.status|slm.modeler.status|projet660.modeler.log|ultimaker.modeler.log"}]')
description string

A short description of the modeler-type


manufacturer string

The the manufacturer of the modeler


name string

The name/model number of the represented modeler (printer).


technology string

The 3d printing technology the modeler uses


Choices
  • Binder Jet
  • CLIP
  • EBM
  • FDM
  • DMLS
  • MJF
  • NA
  • SLS
Example: '"Binder Jet|CLIP|EBM|FDM|DMLS|MJF|NA|SLS"'
uri URI

The URI to the modeler-type


Responses
Status CodeDescription
200

The request was successful

404

RecordNotFound: This means either the record you are trying to access doesn't exists, or you do not have permission to access it

Get information about the different supported modeler-types (printer models)

Get a modeler-type by uuid

Schema (application/json)
PropertyTypeDescription
capture_types array

The capture_types associated with this modeler-type


Example: ('[{"capture_type": ' '"arcam.job.log|carbon3D.modeler.status|catex.modeler.jobs|catex.modeler.status|connex.modeler.log|eos.modeler.log|hp.modeler.status|slm.modeler.status|projet660.modeler.log|ultimaker.modeler.log"}]')
description string

A short description of the modeler-type


manufacturer string

The the manufacturer of the modeler


name string

The name/model number of the represented modeler (printer).


technology string

The 3d printing technology the modeler uses


Choices
  • Binder Jet
  • CLIP
  • EBM
  • FDM
  • DMLS
  • MJF
  • NA
  • SLS
Example: '"Binder Jet|CLIP|EBM|FDM|DMLS|MJF|NA|SLS"'
uri URI

The URI to the modeler-type


Responses
Status CodeDescription
200

The request was successful

404

RecordNotFound: This means either the record you are trying to access doesn't exists, or you do not have permission to access it

/modeler/

get post

Create and update modelers, and get information about them

Get list of modelers with optional filters

Schema (application/json)
PropertyTypeDescription
cassettes array none available
Example: '["..."]'
connected boolean

True if we are able to communicate with the printer, false otherwise. When this property is set to 'false' the status of the modeler will be changed to 'offline' until 'connected' is set back to 'true'. This will even take precedence over error states. This property is normally used by API managed modelers


current_build URI

The current build the modeler is processing


description string

A short description about this modeler


error string

Detailed error status on the modeler, if any.


ip_address string

The local ip address of the modeler, as a string. Supports both IPv4 and IPv6


latest_upload iso-8601 datetime

The last date and time a capture was uploaded for this modeler


name string

The name of the modeler


serial_number string

The serial number of the modeler, as a string


status string

The status of the modeler, or what it's doing. This cannot be directly changed


Choices
  • error
  • idle
  • offline
  • printing
  • maintenance
Example: '"error|idle|offline|printing|maintenance"'
type URI

The URI to the modeler type of this modeler


updated iso-8601 datetime none available
uri URI

The URI to the modeler


Responses
Status CodeDescription
200

The request was successful

400

InvalidType: You have provided a value for 'type' that is not a recognized modeler type

This means the IP address you entered is invald. Make sure your ip address is a valid IPv4 or IPv6 address.

404

RecordNotFound: This means either the record you are trying to access doesn't exists, or you do not have permission to access it

Create a new modeler

Schema (application/json)
PropertyTypeDescription
cassettes array none available
Default: []
Example: '["..."]'
connected boolean

True if we are able to communicate with the printer, false otherwise. When this property is set to 'false' the status of the modeler will be changed to 'offline' until 'connected' is set back to 'true'. This will even take precedence over error states. This property is normally used by API managed modelers


Default: True
current_build URI

The current build the modeler is processing


Required
description string

A short description about this modeler


Default: None
error string

Detailed error status on the modeler, if any.


Required
ip_address string

The local ip address of the modeler, as a string. Supports both IPv4 and IPv6


Default: None
latest_upload iso-8601 datetime

The last date and time a capture was uploaded for this modeler


Required
name string

The name of the modeler


Required
serial_number string

The serial number of the modeler, as a string


Default: None
status string

The status of the modeler, or what it's doing. This cannot be directly changed


Required
Choices
  • error
  • idle
  • offline
  • printing
  • maintenance
Example: '"error|idle|offline|printing|maintenance"'
type URI

The URI to the modeler type of this modeler


Required
updated iso-8601 datetime none available
Default: None
uri URI

The URI to the modeler


Required
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

400

InvalidType: You have provided a value for 'type' that is not a recognized modeler type

This means the IP address you entered is invald. Make sure your ip address is a valid IPv4 or IPv6 address.

404

RecordNotFound: This means either the record you are trying to access doesn't exists, or you do not have permission to access it

Create and update modelers, and get information about them

Get a modeler by URI

Schema (application/json)
PropertyTypeDescription
cassettes array none available
Example: '["..."]'
connected boolean

True if we are able to communicate with the printer, false otherwise. When this property is set to 'false' the status of the modeler will be changed to 'offline' until 'connected' is set back to 'true'. This will even take precedence over error states. This property is normally used by API managed modelers


current_build URI

The current build the modeler is processing


description string

A short description about this modeler


error string

Detailed error status on the modeler, if any.


ip_address string

The local ip address of the modeler, as a string. Supports both IPv4 and IPv6


latest_upload iso-8601 datetime

The last date and time a capture was uploaded for this modeler


name string

The name of the modeler


serial_number string

The serial number of the modeler, as a string


status string

The status of the modeler, or what it's doing. This cannot be directly changed


Choices
  • error
  • idle
  • offline
  • printing
  • maintenance
Example: '"error|idle|offline|printing|maintenance"'
type URI

The URI to the modeler type of this modeler


updated iso-8601 datetime none available
uri URI

The URI to the modeler


Responses
Status CodeDescription
200

The request was successful

400

InvalidType: You have provided a value for 'type' that is not a recognized modeler type

This means the IP address you entered is invald. Make sure your ip address is a valid IPv4 or IPv6 address.

404

RecordNotFound: This means either the record you are trying to access doesn't exists, or you do not have permission to access it

/notifications/

get post

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

No description provided
Schema (application/json)
PropertyTypeDescription
context object none available
Example: 'null'
created iso-8601 datetime none available
emails array none available
Example: '["..."]'
reply_to string none available
template string none available
Choices
  • nautilus.model_upload_failed
  • nautilus.order_complete
  • nautilus.order_created
  • nautilus.order_line_items_confirmed
  • nautilus.order_owner
  • nautilus.order_scheduled
  • nautilus.order_shipped
  • nautilus.order_start_printing
  • nautilus.order_summary
  • nautilus.order_summary_ephemeral_user
  • nautilus.order_update
  • nautilus.print_error
  • nautilus.service_provider_confirmation_email
  • nautilus.service_provider_order_request_email
  • nautilus.service_provider_registration
  • users.password_reset
  • users.welcome_mailer
  • vision.alert
Example: '"nautilus.model_upload_failed|nautilus.order_complete|nautilus.order_created|nautilus.order_line_items_confirmed|nautilus.order_owner|nautilus.order_scheduled|nautilus.order_shipped|nautilus.order_start_printing|nautilus.order_summary|nautilus.order_summary_ephemeral_user|nautilus.order_update|nautilus.print_error|nautilus.service_provider_confirmation_email|nautilus.service_provider_order_request_email|nautilus.service_provider_registration|users.password_reset|users.welcome_mailer|vision.alert"'
uri URI none available
user URI none available
Responses
Status CodeDescription
200

The request was successful

400

notification-failed: An error occurred while trying to send the notification

unknown-template

No description provided
Schema (application/json)
PropertyTypeDescription
context object none available
Required
Example: 'null'
created iso-8601 datetime none available
Default: None
emails array none available
Default: None
Example: '["..."]'
reply_to string none available
Default: None
template string none available
Required
Choices
  • nautilus.model_upload_failed
  • nautilus.order_complete
  • nautilus.order_created
  • nautilus.order_line_items_confirmed
  • nautilus.order_owner
  • nautilus.order_scheduled
  • nautilus.order_shipped
  • nautilus.order_start_printing
  • nautilus.order_summary
  • nautilus.order_summary_ephemeral_user
  • nautilus.order_update
  • nautilus.print_error
  • nautilus.service_provider_confirmation_email
  • nautilus.service_provider_order_request_email
  • nautilus.service_provider_registration
  • users.password_reset
  • users.welcome_mailer
  • vision.alert
Example: '"nautilus.model_upload_failed|nautilus.order_complete|nautilus.order_created|nautilus.order_line_items_confirmed|nautilus.order_owner|nautilus.order_scheduled|nautilus.order_shipped|nautilus.order_start_printing|nautilus.order_summary|nautilus.order_summary_ephemeral_user|nautilus.order_update|nautilus.print_error|nautilus.service_provider_confirmation_email|nautilus.service_provider_order_request_email|nautilus.service_provider_registration|users.password_reset|users.welcome_mailer|vision.alert"'
uri URI none available
Default: None
user URI none available
Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

400

notification-failed: An error occurred while trying to send the notification

unknown-template

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

No description provided
Schema (application/json)
PropertyTypeDescription
context object none available
Example: 'null'
created iso-8601 datetime none available
emails array none available
Example: '["..."]'
reply_to string none available
template string none available
Choices
  • nautilus.model_upload_failed
  • nautilus.order_complete
  • nautilus.order_created
  • nautilus.order_line_items_confirmed
  • nautilus.order_owner
  • nautilus.order_scheduled
  • nautilus.order_shipped
  • nautilus.order_start_printing
  • nautilus.order_summary
  • nautilus.order_summary_ephemeral_user
  • nautilus.order_update
  • nautilus.print_error
  • nautilus.service_provider_confirmation_email
  • nautilus.service_provider_order_request_email
  • nautilus.service_provider_registration
  • users.password_reset
  • users.welcome_mailer
  • vision.alert
Example: '"nautilus.model_upload_failed|nautilus.order_complete|nautilus.order_created|nautilus.order_line_items_confirmed|nautilus.order_owner|nautilus.order_scheduled|nautilus.order_shipped|nautilus.order_start_printing|nautilus.order_summary|nautilus.order_summary_ephemeral_user|nautilus.order_update|nautilus.print_error|nautilus.service_provider_confirmation_email|nautilus.service_provider_order_request_email|nautilus.service_provider_registration|users.password_reset|users.welcome_mailer|vision.alert"'
uri URI none available
user URI none available
Responses
Status CodeDescription
200

The request was successful

400

notification-failed: An error occurred while trying to send the notification

unknown-template

This is a bacsic 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

This is a bacsic 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

500

oauth-error

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

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

The value of the access token right now


expires iso-8601 datetime

The date and time in UTC when this token expires


provider string

The name of the provider the token is for


Choices
  • autodesk-forge
Example: '"autodesk-forge"'
user URI

The user the token is for


uuid uuid none available
Responses
Status CodeDescription
200

The request was successful

/order-comment/

get post

This endpoint is used for making comments on orders. Comments are free-form - different users may assign different meanings to the content of the comments, but over all the comment is merely a way for team members to communicate in an ongoing way about an order

List all of the comments in the system for your account.

Schema (application/json)
PropertyTypeDescription
content string

The comment.


created iso-8601 datetime

The date the comment was created.


order URI

The URI of the order that this comment is about.


public boolean

The type of the comment.


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

The URI of the comment.


user URL

The URI of the user who created the comment.


Responses
Status CodeDescription
200

The request was successful

404

The requested comment cannot be found.

Create a new comment.

Schema (application/json)
PropertyTypeDescription
content string

The comment.


Required
created iso-8601 datetime

The date the comment was created.


Default: None
order URI

The URI of the order that this comment is about.


Default: None
public boolean

The type of the comment.


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

The URI of the comment.


Default: None
user URL

The URI of the user who created the comment.


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

The request was successful

404

The requested comment cannot be found.

This endpoint is used for making comments on orders. Comments are free-form - different users may assign different meanings to the content of the comments, but over all the comment is merely a way for team members to communicate in an ongoing way about an order

Get a single comment by UUID.

Schema (application/json)
PropertyTypeDescription
content string

The comment.


created iso-8601 datetime

The date the comment was created.


order URI

The URI of the order that this comment is about.


public boolean

The type of the comment.


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

The URI of the comment.


user URL

The URI of the user who created the comment.


Responses
Status CodeDescription
200

The request was successful

404

The requested comment cannot be found.

This is a utility API for getting all of the orders for a given location. You supply a location, it returns the orders

List all of the orders at a location in the system for your account.

Schema (application/json)
PropertyTypeDescription
location URI

The URI of the location.


orders array

List of the location's orders.


Example: '["..."]'
Responses
Status CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested stock cannot be found.

/order-offer/

get post

An ‘Order Offer’ is an outbound Quote request our customers send to people who submit them orders. It may include all, or some limited group of Line-Items in the Order it is related to. All ‘Order Offers' relate to an order, but there may be multiple revisions in an ’Order Offer' for a single Order object. They may represent different versions or updates or state-changes in that order’s history.

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.


order URI

The order to get a offer document on.


status string

Status of a report.


Choices
  • pending
  • processing
  • complete
  • error
Example: '"pending|processing|complete|error"'
uri URI

The URI of the order offer.


Responses
Status CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested report cannot be found.

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

The bureau a report belongs to.


Required
content URL

the download link for the document


Default: None
created iso-8601 datetime

The date the report was created.


Default: None
order URI

The order to get a offer document 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 order offer.


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.

An ‘Order Offer’ is an outbound Quote request our customers send to people who submit them orders. It may include all, or some limited group of Line-Items in the Order it is related to. All ‘Order Offers' relate to an order, but there may be multiple revisions in an ’Order Offer' for a single Order object. They may represent different versions or updates or state-changes in that order’s history.

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.


order URI

The order to get a offer document on.


status string

Status of a report.


Choices
  • pending
  • processing
  • complete
  • error
Example: '"pending|processing|complete|error"'
uri URI

The URI of the order offer.


Responses
Status CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested report cannot be found.

Order part quote callback.

Order part quote callback

Schema (application/json)
PropertyTypeDescription
bureau string none available
Required
callback_method string none available
Required
callback_url URL none available
Required
currency string none available
Required
material string none available
Required
model string none available
Required
price float none available
Required
status string none available
Required
uri URL none available
Required
* 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 order part cannot be found.

/order-part/

get post

A Streamics order part record.

List all of the order part in the system for your account.

Schema (application/json)
PropertyTypeDescription
attachments_ids array none available
Example: '["..."]'
build_due_date iso-8601 datetime none available
check_out_date iso-8601 datetime none available
check_out_to string none available
comments array none available
Example: '["..."]'
counters object none available
Example: 'null'
created_by string none available
created_date iso-8601 datetime none available
custom_fields object none available
Example: 'null'
due_date iso-8601 datetime none available
external_id string none available
file_id integer none available
file_name string none available
id integer none available
material_external_id string none available
model_uri URL

The URI of the order part's model.


modified_by string none available
modified_date iso-8601 datetime none available
needs_validation boolean none available
order URI

The URI of the order this order part belongs to.


order_external_id string none available
parameters object none available
Example: 'null'
part_id integer none available
part_name string none available
planned_end_date iso-8601 datetime none available
post_processing_estimation float none available
post_processing_template integer none available
price float none available
quantity integer none available
quoted_part_external_id string none available
quotes array none available
Example: '["..."]'
status string none available
uri URI

The URI of the order part.


Responses
Status CodeDescription
200

The request was successful

404

The requested order part cannot be found.

Create a new order part.

Schema (application/json)
PropertyTypeDescription
attachments_ids array none available
Default: []
Example: '["..."]'
build_due_date iso-8601 datetime none available
Default: None
check_out_date iso-8601 datetime none available
Default: None
check_out_to string none available
Default: None
comments array none available
Default: []
Example: '["..."]'
counters object none available
Default: {}
Example: 'null'
created_by string none available
Required
created_date iso-8601 datetime none available
Required
custom_fields object none available
Required
Example: 'null'
due_date iso-8601 datetime none available
Required
external_id string none available
Required
file_id integer none available
Required
file_name string none available
Required
id integer none available
Required
material_external_id string none available
Required
model_uri URL

The URI of the order part's model.


Required
modified_by string none available
Required
modified_date iso-8601 datetime none available
Required
needs_validation boolean none available
Default: None
order URI

The URI of the order this order part belongs to.


Default: None
order_external_id string none available
Required
parameters object none available
Default: {}
Example: 'null'
part_id integer none available
Required
part_name string none available
Required
planned_end_date iso-8601 datetime none available
Required
post_processing_estimation float none available
Default: None
post_processing_template integer none available
Default: None
price float none available
Default: None
quantity integer none available
Required
quoted_part_external_id string none available
Default: None
quotes array none available
Default: None
Example: '["..."]'
status string none available
Required
uri URI

The URI of the order part.


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

The request was successful

404

The requested order part cannot be found.

A Streamics order part record.

Get a single order part by UUID.

Schema (application/json)
PropertyTypeDescription
attachments_ids array none available
Example: '["..."]'
build_due_date iso-8601 datetime none available
check_out_date iso-8601 datetime none available
check_out_to string none available
comments array none available
Example: '["..."]'
counters object none available
Example: 'null'
created_by string none available
created_date iso-8601 datetime none available
custom_fields object none available
Example: 'null'
due_date iso-8601 datetime none available
external_id string none available
file_id integer none available
file_name string none available
id integer none available
material_external_id string none available
model_uri URL

The URI of the order part's model.


modified_by string none available
modified_date iso-8601 datetime none available
needs_validation boolean none available
order URI

The URI of the order this order part belongs to.


order_external_id string none available
parameters object none available
Example: 'null'
part_id integer none available
part_name string none available
planned_end_date iso-8601 datetime none available
post_processing_estimation float none available
post_processing_template integer none available
price float none available
quantity integer none available
quoted_part_external_id string none available
quotes array none available
Example: '["..."]'
status string none available
uri URI

The URI of the order part.


Responses
Status CodeDescription
200

The request was successful

404

The requested order part cannot be found.

The order-report api is for exporting the details of an Order along with the line-items associated with it as a printable csv.

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

The request was successful

A third party is where an order can be placed.

List all of the order in the system for your account.

Schema (application/json)
PropertyTypeDescription
attachments_ids array none available
Example: '["..."]'
build_due_date iso-8601 datetime none available
comments array none available
Example: '["..."]'
contact_person_external_id string none available
created_by string none available
created_date iso-8601 datetime none available
custom_fields object none available
Example: 'null'
due_date iso-8601 datetime none available
external_id string none available
id integer none available
modified_by string none available
modified_date iso-8601 datetime none available
ordered_parts_total_quantity integer none available
planned_end_date iso-8601 datetime none available
price float none available
quote_external_id string none available
status string none available
uri URI

The URI of the order.


Responses
Status CodeDescription
200

The request was successful

404

The requested order cannot be found.

Create a new order.

Schema (application/json)
PropertyTypeDescription
attachments_ids array none available
Required
Example: '["..."]'
build_due_date iso-8601 datetime none available
Default: None
comments array none available
Default: []
Example: '["..."]'
contact_person_external_id string none available
Required
created_by string none available
Required
created_date iso-8601 datetime none available
Required
custom_fields object none available
Default: {}
Example: 'null'
due_date iso-8601 datetime none available
Required
external_id string none available
Required
id integer none available
Required
modified_by string none available
Required
modified_date iso-8601 datetime none available
Required
ordered_parts_total_quantity integer none available
Required
planned_end_date iso-8601 datetime none available
Required
price float none available
Default: None
quote_external_id string none available
Default: None
status string none available
Required
uri URI

The URI of the order.


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

The request was successful

404

The requested order cannot be found.

A third party is where an order can be placed.

Get a single order by UUID.

Schema (application/json)
PropertyTypeDescription
attachments_ids array none available
Example: '["..."]'
build_due_date iso-8601 datetime none available
comments array none available
Example: '["..."]'
contact_person_external_id string none available
created_by string none available
created_date iso-8601 datetime none available
custom_fields object none available
Example: 'null'
due_date iso-8601 datetime none available
external_id string none available
id integer none available
modified_by string none available
modified_date iso-8601 datetime none available
ordered_parts_total_quantity integer none available
planned_end_date iso-8601 datetime none available
price float none available
quote_external_id string none available
status string none available
uri URI

The URI of the order.


Responses
Status CodeDescription
200

The request was successful

404

The requested order cannot be found.

/order/

get post

An order is how a user tells the system they would like a particular bureau to build a particular part or parts. The order is mostly composed of line-item resources which should be created before creating the order. Each line item contains information on a particular model in a particular quantity to produce. The order then aggregates the line-items with metadata about the currency to quote the order in, total estimates of cost and time, shipping information to use to send the parts to the customer and overall status of the order.

The status of an order is normally calculated as the aggregate status of the line-items of the order. When an order has all line items printing, the status is printing. When all line items are complete, the order is complete.

Orders should normally be specified with the bureau, currency, line_items, name and shipping. Other fields are populated as the order moves through the system towards completion

List all of the order in the system for your account.

Schema (application/json)
PropertyTypeDescription
actual_amount float

Actual amount.


application_type string

Application type, field specific to business-segment bureaus.


Choices
  • prototype
  • tooling
  • end_component
Example: '"prototype|tooling|end_component"'
bureau URI

The URI of the bureau.


business_segment string

All the business segment for a particular bureau.


Choices
  • Cooling-EU
  • Cooling-NAM
  • Cooling-ASIA
  • Power-Solutions-EU
  • Power-Solutions-NAM
  • Power-Solutions-SAM
  • Power-Solutions-ASIA
  • Drives-EU
  • Drives-NAM
  • Drives-ASIA
  • Heating-EU
  • Heating-NAM
  • Heating-ASIA
  • Danfoss-Group-NAM
  • Danfoss-Group-SAM
  • Danfoss-Group-ASIA
  • Danfoss-Group-EU
Example: '"Cooling-EU|Cooling-NAM|Cooling-ASIA|Power-Solutions-EU|Power-Solutions-NAM|Power-Solutions-SAM|Power-Solutions-ASIA|Drives-EU|Drives-NAM|Drives-ASIA|Heating-EU|Heating-NAM|Heating-ASIA|Danfoss-Group-NAM|Danfoss-Group-SAM|Danfoss-Group-ASIA|Danfoss-Group-EU"'
business_unit URI

The URI of the business unit.


callback_method string

Callback method


callback_url string

Callback URL


channel_representative string

Channel Rep user URI for the order.


country string

3 digit ISO 3166 country code for non danfoss bureau


created iso-8601 datetime

The date the order was created.


created_by string

Name of user that created order


currency string

The currency of the order.


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"'
custom_field_values array none available
Example: '[{}]'
customer_email string

Customer email address.


customer_name string

Customer name for the order.


customer_po string

Customer PO which is a reference to Customer number.


due_date iso-8601 datetime

The due date for the order.


error string none available
estimates object none available
Example: '{"cost": {}, "materials": {}}'
external_id string

External ID for an order.


ip_sensitivity string

The intellectual property sensitivity.


line_items array

The uri of the line items for this order.


Example: '["..."]'
location URI

URI of the location


locations_available array

list of manufacturing locations available for this order


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

Name of the order.


notes string

Notes for the order.


order_offer_approved boolean

Date and time when certain revision of order offer was approved.


order_offer_discount float

Discount that should be applied for total cost in order offer.


order_offer_required boolean

Whether order offer workflow required or not.


order_owner string

The URI of the order owner.


order_type string

Order type choices. Choice depends on the bureau.


Choices
  • benchmark
  • commercial
  • r-d
  • sample-free
  • timestudy
Example: '"benchmark|commercial|r-d|sample-free|timestudy"'
quote_number string

A reference to Sales quotes


region string

Region of the order.


sales_representative string

Sales Rep user URI for the order.


sales_status string

Status of the sales for the order.


Choices
  • won
  • lost
  • outsourced
  • dead
  • pending
Example: '"won|lost|outsourced|dead|pending"'
shipping object none available
Example: '{}'
special_processing_required boolean

Whether re-design hours or special post-processing required or not.


status string

Status of an order.


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

The URI of the order.


user URI

The URI of the user who created the order.


Responses
Status CodeDescription
200

The request was successful

400

invalid-payload: The value you provided for bureau does not appear to be a valid bureau

The quantity value is too low or too high

The model does not seem printable

An order with active prints cannot be deleted

Provided status transformation is not allowed

You cannot delete order which already was confirmed.

Order offer can't be generated if order confirmed. Or, cannot be approved if there is no customer_po specified.

404

The requested order cannot be found.

Create a new order.

Schema (application/json)
PropertyTypeDescription
actual_amount float

Actual amount.


Default: None
application_type string

Application type, field specific to business-segment bureaus.


Default: None
Choices
  • prototype
  • tooling
  • end_component
Example: '"prototype|tooling|end_component"'
bureau URI

The URI of the bureau.


Required
business_segment string

All the business segment for a particular bureau.


Default: None
Choices
  • Cooling-EU
  • Cooling-NAM
  • Cooling-ASIA
  • Power-Solutions-EU
  • Power-Solutions-NAM
  • Power-Solutions-SAM
  • Power-Solutions-ASIA
  • Drives-EU
  • Drives-NAM
  • Drives-ASIA
  • Heating-EU
  • Heating-NAM
  • Heating-ASIA
  • Danfoss-Group-NAM
  • Danfoss-Group-SAM
  • Danfoss-Group-ASIA
  • Danfoss-Group-EU
Example: '"Cooling-EU|Cooling-NAM|Cooling-ASIA|Power-Solutions-EU|Power-Solutions-NAM|Power-Solutions-SAM|Power-Solutions-ASIA|Drives-EU|Drives-NAM|Drives-ASIA|Heating-EU|Heating-NAM|Heating-ASIA|Danfoss-Group-NAM|Danfoss-Group-SAM|Danfoss-Group-ASIA|Danfoss-Group-EU"'
business_unit URI

The URI of the business unit.


Default: None
callback_method string

Callback method


Default: None
callback_url string

Callback URL


Default: None
channel_representative string

Channel Rep user URI for the order.


Default: None
country string

3 digit ISO 3166 country code for non danfoss bureau


Default: None
created iso-8601 datetime

The date the order was created.


Default: None
created_by string

Name of user that created order


Default: None
currency string

The currency of the order.


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"'
custom_field_values array none available
Default: None
Example: '[{}]'
customer_email string

Customer email address.


Default: None
customer_name string

Customer name for the order.


Default: None
customer_po string

Customer PO which is a reference to Customer number.


Default: None
due_date iso-8601 datetime

The due date for the order.


Default: None
error string none available
Default: None
estimates object none available
Default: None
Example: '{"cost": {}, "materials": {}}'
external_id string

External ID for an order.


Default: None
ip_sensitivity string

The intellectual property sensitivity.


Default: None
line_items array

The uri of the line items for this order.


Required
Example: '["..."]'
location URI

URI of the location


Default: None
locations_available array

list of manufacturing locations available for this order


Default: []
Example: '["..."]'
name string

Name of the order.


Required
notes string

Notes for the order.


Default: None
order_offer_approved boolean

Date and time when certain revision of order offer was approved.


Default: False
order_offer_discount float

Discount that should be applied for total cost in order offer.


Default: None
order_offer_required boolean

Whether order offer workflow required or not.


Default: False
order_owner string

The URI of the order owner.


Default: None
order_type string

Order type choices. Choice depends on the bureau.


Default: None
Choices
  • benchmark
  • commercial
  • r-d
  • sample-free
  • timestudy
Example: '"benchmark|commercial|r-d|sample-free|timestudy"'
quote_number string

A reference to Sales quotes


Default: None
region string

Region of the order.


Default: None
sales_representative string

Sales Rep user URI for the order.


Default: None
sales_status string

Status of the sales for the order.


Default: None
Choices
  • won
  • lost
  • outsourced
  • dead
  • pending
Example: '"won|lost|outsourced|dead|pending"'
shipping object none available
Required
Example: '{}'
special_processing_required boolean

Whether re-design hours or special post-processing required or not.


Default: False
status string

Status of an order.


Default: None
Choices
  • calculating_estimates
  • cancelled
  • confirmed
  • complete
  • error
  • new
  • pending
  • processing
  • post-processing
  • printed
  • printing
  • shipping
Example: '"calculating_estimates|cancelled|confirmed|complete|error|new|pending|processing|post-processing|printed|printing|shipping"'
uri URI

The URI of the order.


Default: None
user URI

The URI of the user who created the order.


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

The request was successful

400

invalid-payload: The value you provided for bureau does not appear to be a valid bureau

The quantity value is too low or too high

The model does not seem printable

An order with active prints cannot be deleted

Provided status transformation is not allowed

You cannot delete order which already was confirmed.

Order offer can't be generated if order confirmed. Or, cannot be approved if there is no customer_po specified.

404

The requested order cannot be found.

This is an internal API used by the system

No description provided
Schema (application/json)
PropertyTypeDescription
bureau string none available
Required
callback_method string none available
Required
callback_url URL none available
Required
currency string none available
Required
material string none available
Required
model string none available
Required
price float none available
Required
status string none available
Required
uri URL none available
Required
* 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 order cannot be found.

This is an internal API used for returning estimates data about an order

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 order cannot be found.

An order is how a user tells the system they would like a particular bureau to build a particular part or parts. The order is mostly composed of line-item resources which should be created before creating the order. Each line item contains information on a particular model in a particular quantity to produce. The order then aggregates the line-items with metadata about the currency to quote the order in, total estimates of cost and time, shipping information to use to send the parts to the customer and overall status of the order.

The status of an order is normally calculated as the aggregate status of the line-items of the order. When an order has all line items printing, the status is printing. When all line items are complete, the order is complete.

Orders should normally be specified with the bureau, currency, line_items, name and shipping. Other fields are populated as the order moves through the system towards completion

Get a single order by UUID.

Schema (application/json)
PropertyTypeDescription
actual_amount float

Actual amount.


application_type string

Application type, field specific to business-segment bureaus.


Choices
  • prototype
  • tooling
  • end_component
Example: '"prototype|tooling|end_component"'
bureau URI

The URI of the bureau.


business_segment string

All the business segment for a particular bureau.


Choices
  • Cooling-EU
  • Cooling-NAM
  • Cooling-ASIA
  • Power-Solutions-EU
  • Power-Solutions-NAM
  • Power-Solutions-SAM
  • Power-Solutions-ASIA
  • Drives-EU
  • Drives-NAM
  • Drives-ASIA
  • Heating-EU
  • Heating-NAM
  • Heating-ASIA
  • Danfoss-Group-NAM
  • Danfoss-Group-SAM
  • Danfoss-Group-ASIA
  • Danfoss-Group-EU
Example: '"Cooling-EU|Cooling-NAM|Cooling-ASIA|Power-Solutions-EU|Power-Solutions-NAM|Power-Solutions-SAM|Power-Solutions-ASIA|Drives-EU|Drives-NAM|Drives-ASIA|Heating-EU|Heating-NAM|Heating-ASIA|Danfoss-Group-NAM|Danfoss-Group-SAM|Danfoss-Group-ASIA|Danfoss-Group-EU"'
business_unit URI

The URI of the business unit.


callback_method string

Callback method


callback_url string

Callback URL


channel_representative string

Channel Rep user URI for the order.


country string

3 digit ISO 3166 country code for non danfoss bureau


created iso-8601 datetime

The date the order was created.


created_by string

Name of user that created order


currency string

The currency of the order.


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"'
custom_field_values array none available
Example: '[{}]'
customer_email string

Customer email address.


customer_name string

Customer name for the order.


customer_po string

Customer PO which is a reference to Customer number.


due_date iso-8601 datetime

The due date for the order.


error string none available
estimates object none available
Example: '{"cost": {}, "materials": {}}'
external_id string

External ID for an order.


ip_sensitivity string

The intellectual property sensitivity.


line_items array

The uri of the line items for this order.


Example: '["..."]'
location URI

URI of the location


locations_available array

list of manufacturing locations available for this order


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

Name of the order.


notes string

Notes for the order.


order_offer_approved boolean

Date and time when certain revision of order offer was approved.


order_offer_discount float

Discount that should be applied for total cost in order offer.


order_offer_required boolean

Whether order offer workflow required or not.


order_owner string

The URI of the order owner.


order_type string

Order type choices. Choice depends on the bureau.


Choices
  • benchmark
  • commercial
  • r-d
  • sample-free
  • timestudy
Example: '"benchmark|commercial|r-d|sample-free|timestudy"'
quote_number string

A reference to Sales quotes


region string

Region of the order.


sales_representative string

Sales Rep user URI for the order.


sales_status string

Status of the sales for the order.


Choices
  • won
  • lost
  • outsourced
  • dead
  • pending
Example: '"won|lost|outsourced|dead|pending"'
shipping object none available
Example: '{}'
special_processing_required boolean

Whether re-design hours or special post-processing required or not.


status string

Status of an order.


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

The URI of the order.


user URI

The URI of the user who created the order.


Responses
Status CodeDescription
200

The request was successful

400

invalid-payload: The value you provided for bureau does not appear to be a valid bureau

The quantity value is too low or too high

The model does not seem printable

An order with active prints cannot be deleted

Provided status transformation is not allowed

You cannot delete order which already was confirmed.

Order offer can't be generated if order confirmed. Or, cannot be approved if there is no customer_po specified.

404

The requested order cannot be found.

Get information about parts. This is just a placeholder and not yet implemented

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

The request was successful

400

NotImplementedError

A permision bureau record represenst a right that is created for a user on the bureau. This right such as material.all will allow the user to edit, update, and delete the associated record type. In this case it is material. Creating a record here will grant the user access to perform the associated actions. Deleting will revoke the permission.

List all of the bureau permissions in the system.

Schema (application/json)
PropertyTypeDescription
bureau URI

The URI of the bureau.


right string

Right for the permission.


Choices
  • currency_conversion.all
  • location.all
  • manufacturer.all
  • material.all
  • model_library.all
  • bureau.permission.all
  • post_processor_type.all
  • printer_type.all
  • service_provider.all
  • shipping.all
  • specimen.all
  • third_party.all
  • workflow.all
Example: '"currency_conversion.all|location.all|manufacturer.all|material.all|model_library.all|bureau.permission.all|post_processor_type.all|printer_type.all|service_provider.all|shipping.all|specimen.all|third_party.all|workflow.all"'
uri URI

The URI of the bureau.


user string

User associated to the permission.


Responses
Status CodeDescription
200

The request was successful

404

The requested permission is not found.

Create a new bureau permission.

Schema (application/json)
PropertyTypeDescription
bureau URI

The URI of the bureau.


Required
right string

Right for the permission.


Required
Choices
  • currency_conversion.all
  • location.all
  • manufacturer.all
  • material.all
  • model_library.all
  • bureau.permission.all
  • post_processor_type.all
  • printer_type.all
  • service_provider.all
  • shipping.all
  • specimen.all
  • third_party.all
  • workflow.all
Example: '"currency_conversion.all|location.all|manufacturer.all|material.all|model_library.all|bureau.permission.all|post_processor_type.all|printer_type.all|service_provider.all|shipping.all|specimen.all|third_party.all|workflow.all"'
uri URI

The URI of the bureau.


Default: None
user string

User associated to the permission.


Required
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

The requested permission is not found.

A permision bureau record represenst a right that is created for a user on the bureau. This right such as material.all will allow the user to edit, update, and delete the associated record type. In this case it is material. Creating a record here will grant the user access to perform the associated actions. Deleting will revoke the permission.

Get a single bureau permission.

Schema (application/json)
PropertyTypeDescription
bureau URI

The URI of the bureau.


right string

Right for the permission.


Choices
  • currency_conversion.all
  • location.all
  • manufacturer.all
  • material.all
  • model_library.all
  • bureau.permission.all
  • post_processor_type.all
  • printer_type.all
  • service_provider.all
  • shipping.all
  • specimen.all
  • third_party.all
  • workflow.all
Example: '"currency_conversion.all|location.all|manufacturer.all|material.all|model_library.all|bureau.permission.all|post_processor_type.all|printer_type.all|service_provider.all|shipping.all|specimen.all|third_party.all|workflow.all"'
uri URI

The URI of the bureau.


user string

User associated to the permission.


Responses
Status CodeDescription
200

The request was successful

404

The requested permission is not found.

A permission location record represent a right that is created for a user on the location. This right such as material.all will allow the user to edit, update, and delete the associated record type. In this case it is material. Creating a record here will grant the user access to perform the associated actions. Deleting will revoke the permission.

List all of the location permissions in the system.

Schema (application/json)
PropertyTypeDescription
location URI

The URI of the location.


right string

Right for the permission.


Choices
  • location.permission.all
  • post_processor.all
  • printer.all
  • stock.all
Example: '"location.permission.all|post_processor.all|printer.all|stock.all"'
uri URI

The URI of the location.


user string

User associated to the permission.


Responses
Status CodeDescription
200

The request was successful

404

The requested permission is not found.

Create a new location permission.

Schema (application/json)
PropertyTypeDescription
location URI

The URI of the location.


Required
right string

Right for the permission.


Required
Choices
  • location.permission.all
  • post_processor.all
  • printer.all
  • stock.all
Example: '"location.permission.all|post_processor.all|printer.all|stock.all"'
uri URI

The URI of the location.


Default: None
user string

User associated to the permission.


Required
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

The requested permission is not found.

A permission location record represent a right that is created for a user on the location. This right such as material.all will allow the user to edit, update, and delete the associated record type. In this case it is material. Creating a record here will grant the user access to perform the associated actions. Deleting will revoke the permission.

Get a single location permission.

Schema (application/json)
PropertyTypeDescription
location URI

The URI of the location.


right string

Right for the permission.


Choices
  • location.permission.all
  • post_processor.all
  • printer.all
  • stock.all
Example: '"location.permission.all|post_processor.all|printer.all|stock.all"'
uri URI

The URI of the location.


user string

User associated to the permission.


Responses
Status CodeDescription
200

The request was successful

404

The requested permission is not found.

/permissions/

get post

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

No description provided
Schema (application/json)
PropertyTypeDescription
created_by URI none available
holder string none available
namespace string none available
object string none available
resource_name string none available
right string none available
uri URI none available
Responses
Status CodeDescription
200

The request was successful

400

invalid-holder

invalid-holder

No description provided
Schema (application/json)
PropertyTypeDescription
created_by URI none available
Default: None
holder string none available
Default: *
namespace string none available
Required
object string none available
Required
resource_name string none available
Default: None
right string none available
Required
uri URI none available
Default: None
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

400

invalid-holder

invalid-holder

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

No description provided
Schema (application/json)
PropertyTypeDescription
created_by URI none available
holder string none available
namespace string none available
object string none available
resource_name string none available
right string none available
uri URI none available
Responses
Status CodeDescription
200

The request was successful

400

invalid-holder

invalid-holder

This resource defines a type of post-processing a bureau can handle. Examples might include painting, caustic bath, sanding, milling or other processes that refine a part before final delivery to a customer.

After creating a post-processor type you'll want to create instances of post-processors that satisfy the type in particular locations via the post-processor API

List all of the post-processor-types in the system for your account.

Schema (application/json)
PropertyTypeDescription
batching_strategy string

Batching Strategy which describe how should be grouped Prints for Run with this Post Processor type.


Choices
  • by_size_xyz
  • by_size_xy
  • by_number_of_parts
  • match_previous
  • single
Example: '"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single"'
build_volume object

Dimensions of the build volume in millimeters. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


Example: '{}'
bureau URI

Bureau of the post-processor-type


cost float

The cost of the post processor per minute


description string

Description of the post-processor-type.


duration integer

The length of time it will take to complete post process in seconds.


manufacturer URI

Manufacturer of the post-processor-type


materials array

The URI of materials from the manufacturer.


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

Min distance between Parts. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


name string

Name of the post-processor-type.


number_of_parts integer

Max number of Prints in Run. Used when batching_strategy == 'by_number_of_parts'


uri URI

The URI of the post-processor-type.


Responses
Status CodeDescription
200

The request was successful

400

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 post processor type name already exists.

invalid-payload: Missed required fields for provided Batching Strategy.

The value you provided for materials does not appear to be a valid material

403

You are not authorized to complete the request.

404

The requested post-processor-type cannot be found.

Create a new post-processor-type.

Schema (application/json)
PropertyTypeDescription
batching_strategy string

Batching Strategy which describe how should be grouped Prints for Run with this Post Processor type.


Default: match_previous
Choices
  • by_size_xyz
  • by_size_xy
  • by_number_of_parts
  • match_previous
  • single
Example: '"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single"'
build_volume object

Dimensions of the build volume in millimeters. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


Required
Example: '{}'
bureau URI

Bureau of the post-processor-type


Required
cost float

The cost of the post processor per minute


Default: None
description string

Description of the post-processor-type.


Required
duration integer

The length of time it will take to complete post process in seconds.


Required
manufacturer URI

Manufacturer of the post-processor-type


Required
materials array

The URI of materials from the manufacturer.


Required
Example: '["..."]'
min_packing_distance float

Min distance between Parts. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


Default: None
name string

Name of the post-processor-type.


Required
number_of_parts integer

Max number of Prints in Run. Used when batching_strategy == 'by_number_of_parts'


Default: None
uri URI

The URI of the post-processor-type.


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

The request was successful

400

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 post processor type name already exists.

invalid-payload: Missed required fields for provided Batching Strategy.

The value you provided for materials does not appear to be a valid material

403

You are not authorized to complete the request.

404

The requested post-processor-type cannot be found.

This resource defines a type of post-processing a bureau can handle. Examples might include painting, caustic bath, sanding, milling or other processes that refine a part before final delivery to a customer.

After creating a post-processor type you'll want to create instances of post-processors that satisfy the type in particular locations via the post-processor API

Get a single post-processor-type.

Schema (application/json)
PropertyTypeDescription
batching_strategy string

Batching Strategy which describe how should be grouped Prints for Run with this Post Processor type.


Choices
  • by_size_xyz
  • by_size_xy
  • by_number_of_parts
  • match_previous
  • single
Example: '"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single"'
build_volume object

Dimensions of the build volume in millimeters. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


Example: '{}'
bureau URI

Bureau of the post-processor-type


cost float

The cost of the post processor per minute


description string

Description of the post-processor-type.


duration integer

The length of time it will take to complete post process in seconds.


manufacturer URI

Manufacturer of the post-processor-type


materials array

The URI of materials from the manufacturer.


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

Min distance between Parts. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


name string

Name of the post-processor-type.


number_of_parts integer

Max number of Prints in Run. Used when batching_strategy == 'by_number_of_parts'


uri URI

The URI of the post-processor-type.


Responses
Status CodeDescription
200

The request was successful

400

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 post processor type name already exists.

invalid-payload: Missed required fields for provided Batching Strategy.

The value you provided for materials does not appear to be a valid material

403

You are not authorized to complete the request.

404

The requested post-processor-type cannot be found.

/post-processor/

get post

Post processor is an instance of a particular post-processor. This is normally set up shortly after a post-processor-type and a valid location is set up. A user who has a permission to add post-processor for a particular bureau will be able to create an instance of post processor.

A post-processor should match to a physical device that can perform post-processing of the provided type at the provided location. post-processors are used by the system to schedule time to perform post-processing, queue orders to be worked on and keep track of material usage and availability

List all of the post-processor in the system for your account.

Schema (application/json)
PropertyTypeDescription
duration integer

The length of time it will take to complete post process in seconds.


location URI

The URI of a valid location.


name string

The name of the post-processor.


post_processor_type URI

The URI of a valid post-processor-type.


queue array

Ordered list of run URIs quesed on the post processor.


Example: '["..."]'
uri URI

The URI of the post-processor.


Responses
Status CodeDescription
200

The request was successful

400

You cannot change the position of an already post processing job.

The requested post processor name already exists.

Cannot delete post-processor that has runs in queue. Remove runs before deleting post-processor.

403

You are not authorized to complete the request.

404

The requested post-processor cannot be found.

Create a new post-processor.

Schema (application/json)
PropertyTypeDescription
duration integer

The length of time it will take to complete post process in seconds.


Required
location URI

The URI of a valid location.


Required
name string

The name of the post-processor.


Required
post_processor_type URI

The URI of a valid post-processor-type.


Required
queue array

Ordered list of run URIs quesed on the post processor.


Default: []
Example: '["..."]'
uri URI

The URI of the post-processor.


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

The request was successful

400

You cannot change the position of an already post processing job.

The requested post processor name already exists.

Cannot delete post-processor that has runs in queue. Remove runs before deleting post-processor.

403

You are not authorized to complete the request.

404

The requested post-processor cannot be found.

Post processor is an instance of a particular post-processor. This is normally set up shortly after a post-processor-type and a valid location is set up. A user who has a permission to add post-processor for a particular bureau will be able to create an instance of post processor.

A post-processor should match to a physical device that can perform post-processing of the provided type at the provided location. post-processors are used by the system to schedule time to perform post-processing, queue orders to be worked on and keep track of material usage and availability

Get a single post-processor by UUID.

Schema (application/json)
PropertyTypeDescription
duration integer

The length of time it will take to complete post process in seconds.


location URI

The URI of a valid location.


name string

The name of the post-processor.


post_processor_type URI

The URI of a valid post-processor-type.


queue array

Ordered list of run URIs quesed on the post processor.


Example: '["..."]'
uri URI

The URI of the post-processor.


Responses
Status CodeDescription
200

The request was successful

400

You cannot change the position of an already post processing job.

The requested post processor name already exists.

Cannot delete post-processor that has runs in queue. Remove runs before deleting post-processor.

403

You are not authorized to complete the request.

404

The requested post-processor cannot be found.

/print/

get

A print resource represents a single print to be performed by a 3D printer. The print is tied to a line-item from an order which needs to be fulfilled. If a line-item has multiple copies requested then there will be a separate print for each of those copies.

List all of the print in the system for your account.

Schema (application/json)
PropertyTypeDescription
base_material uuid

Base material of attached line-item.


bureau URI

The URI of print's bureau.


copy integer

Copy number in the quantity the print belongs to. If a customer requests 4 copies there will be 4 separate prints and each will have a different copy number from 1-4


filter_by_line_item_status boolean

Filter prints by line-item statuses


line_item URI

The URI of print's line item.


location uuid

Location of attached order.


material_name string

Name of material


name string

The autogenerated name of the print


order URI

The URI of print's order.


order_due_date string

The due date of order


order_name string

The name of print's order.


order_step_status string

Status of the order step.


Choices
  • complete
  • error
  • new
  • processing
Example: '"complete|error|new|processing"'
post_processor_run URI

The URI of print's post-processor run, if any. Prints are eventually collected together in a run to be manufactured by a specific post-processor. If this value is null then no post-processor has yet been selected for the print.


printer uuid

Printer UUID


process_step URI

The URI of the process step this print is tied to.


process_step_position integer

Step position the print belongs to


reworked_to uuid

UUID of print, to which this one was reworked to.


run URI

The URI of print's run, if any. Prints are eventually collected together in a run to be manufactured by a specific printer. If this value is null then no printer has yet been selected for the print.


size integer

The size of print item


status string

Status of the print.


type string

Type of the Print


Choices
  • product
  • specimen
  • waste
  • tooling
Example: '"product|specimen|waste|tooling"'
uri URI

The URI of the print.


work_needed boolean

Filter prints depending on what in reworked_to field


workflow uuid

Workflow of attached line-item.


Responses
Status CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested print cannot be found.

A print resource represents a single print to be performed by a 3D printer. The print is tied to a line-item from an order which needs to be fulfilled. If a line-item has multiple copies requested then there will be a separate print for each of those copies.

Get a single print by UUID.

Schema (application/json)
PropertyTypeDescription
base_material uuid

Base material of attached line-item.


bureau URI

The URI of print's bureau.


copy integer

Copy number in the quantity the print belongs to. If a customer requests 4 copies there will be 4 separate prints and each will have a different copy number from 1-4


filter_by_line_item_status boolean

Filter prints by line-item statuses


line_item URI

The URI of print's line item.


location uuid

Location of attached order.


material_name string

Name of material


name string

The autogenerated name of the print


order URI

The URI of print's order.


order_due_date string

The due date of order


order_name string

The name of print's order.


order_step_status string

Status of the order step.


Choices
  • complete
  • error
  • new
  • processing
Example: '"complete|error|new|processing"'
post_processor_run URI

The URI of print's post-processor run, if any. Prints are eventually collected together in a run to be manufactured by a specific post-processor. If this value is null then no post-processor has yet been selected for the print.


printer uuid

Printer UUID


process_step URI

The URI of the process step this print is tied to.


process_step_position integer

Step position the print belongs to


reworked_to uuid

UUID of print, to which this one was reworked to.


run URI

The URI of print's run, if any. Prints are eventually collected together in a run to be manufactured by a specific printer. If this value is null then no printer has yet been selected for the print.


size integer

The size of print item


status string

Status of the print.


type string

Type of the Print


Choices
  • product
  • specimen
  • waste
  • tooling
Example: '"product|specimen|waste|tooling"'
uri URI

The URI of the print.


work_needed boolean

Filter prints depending on what in reworked_to field


workflow uuid

Workflow of attached line-item.


Responses
Status CodeDescription
200

The request was successful

403

You are not authorized to complete the request.

404

The requested print cannot be found.

/printer-type/

get post

A printer type defines a pattern to be used by printer resources. Usually a printer-type should correspond to the model of a printer the bureau owns and operates. build_volume information is used for capacity planning and to lay out models together to fill a build area for better efficiency. The materials property identifies which types of materials the printer can consume when building a part and is used to match orders up with printer capabilities for scheduling

Without filters - list all of the printer-types in the system for user's bureau.

By default - will return all records for Bureau and exclude all templates. If passed is_template == True - will will return only shared between bureaus records and will exclude printer-types for current user bureau.

Schema (application/json)
PropertyTypeDescription
base_template URI

Indicates the URI of Printer Type (from the shared library with is_template == True) from which this Printer Type was cloned. If this field is not None - then users can not edit next fields: .


build_packer_type string

The type of packing supported by this printer.


Choices
  • pack2d
  • pack3d
Example: '"pack2d|pack3d"'
build_volume object

Dimensions of the build volume in millimeters.


Example: '{}'
bureau URI

The bureau the printer belongs to


constant_overhead float

A constant overhead used for the printing process.


description string

Description of the printer-type.


infill_strategies array

A list of infill strategies URIs that this printer can use.


Example: '["..."]'
is_template boolean

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


manufacturer URI

Manufacturer of the printer


material_cost_scale_factor integer

A scaling factor multiplied with material cost


materials array

A list of material URIs that this printer can use. Both support and base materials should be included in this list


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

The minimum spacing required between packed models.


name string

Name of the printer-type, such as Fortus 250 or ProJet 660


overhead_per_line_item float

Overhead cost per line item


print_cost_scale_factor integer

A scaling factor multiplied with print cost


running_cost_per_hour float

The cost for running the printer type per hour.


support_strategies array

A list of support strategies URIs that this printer can use.


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

Buffer time after printing process in seconds.


time_before_print integer

Buffer time before printing will start in seconds.


type string

Technology used by the printer such as DLMS or FDM


uri URI

The URI of the printer-type.


Responses
Status CodeDescription
200

The request was successful

400

The requested printer type name already exists.

You cannot delete this printer_type because there are printers associated with it. Delete all printers of this type first.

There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau.

The value you provided for materials does not appear to be a valid material

403

You are not authorized to complete the request.

404

The requested printer type cannot be found.

Create a new printer-type.

Schema (application/json)
PropertyTypeDescription
base_template URI

Indicates the URI of Printer Type (from the shared library with is_template == True) from which this Printer Type was cloned. If this field is not None - then users can not edit next fields: .


Required
build_packer_type string

The type of packing supported by this printer.


Default: pack2d
Choices
  • pack2d
  • pack3d
Example: '"pack2d|pack3d"'
build_volume object

Dimensions of the build volume in millimeters.


Required
Example: '{}'
bureau URI

The bureau the printer belongs to


Default: None
constant_overhead float

A constant overhead used for the printing process.


Default: None
description string

Description of the printer-type.


Required
infill_strategies array

A list of infill strategies URIs that this printer can use.


Default: []
Example: '["..."]'
is_template boolean

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


Required
manufacturer URI

Manufacturer of the printer


Required
material_cost_scale_factor integer

A scaling factor multiplied with material cost


Default: 1
materials array

A list of material URIs that this printer can use. Both support and base materials should be included in this list


Required
Example: '["..."]'
min_packing_distance float

The minimum spacing required between packed models.


Default: 5
name string

Name of the printer-type, such as Fortus 250 or ProJet 660


Required
overhead_per_line_item float

Overhead cost per line item


Default: None
print_cost_scale_factor integer

A scaling factor multiplied with print cost


Default: 1
running_cost_per_hour float

The cost for running the printer type per hour.


Default: None
support_strategies array

A list of support strategies URIs that this printer can use.


Default: []
Example: '["..."]'
time_after_print integer

Buffer time after printing process in seconds.


Default: 0
time_before_print integer

Buffer time before printing will start in seconds.


Default: 0
type string

Technology used by the printer such as DLMS or FDM


Default: None
uri URI

The URI of the printer-type.


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

The request was successful

400

The requested printer type name already exists.

You cannot delete this printer_type because there are printers associated with it. Delete all printers of this type first.

There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau.

The value you provided for materials does not appear to be a valid material

403

You are not authorized to complete the request.

404

The requested printer type cannot be found.

Clone Printer Type to the bureau level from the template (shared) Printer Type

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 printer type cannot be found.

A printer type defines a pattern to be used by printer resources. Usually a printer-type should correspond to the model of a printer the bureau owns and operates. build_volume information is used for capacity planning and to lay out models together to fill a build area for better efficiency. The materials property identifies which types of materials the printer can consume when building a part and is used to match orders up with printer capabilities for scheduling

Get a single printer-type by UUID.

Schema (application/json)
PropertyTypeDescription
base_template URI

Indicates the URI of Printer Type (from the shared library with is_template == True) from which this Printer Type was cloned. If this field is not None - then users can not edit next fields: .


build_packer_type string

The type of packing supported by this printer.


Choices
  • pack2d
  • pack3d
Example: '"pack2d|pack3d"'
build_volume object

Dimensions of the build volume in millimeters.


Example: '{}'
bureau URI

The bureau the printer belongs to


constant_overhead float

A constant overhead used for the printing process.


description string

Description of the printer-type.


infill_strategies array

A list of infill strategies URIs that this printer can use.


Example: '["..."]'
is_template boolean

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


manufacturer URI

Manufacturer of the printer


material_cost_scale_factor integer

A scaling factor multiplied with material cost


materials array

A list of material URIs that this printer can use. Both support and base materials should be included in this list


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

The minimum spacing required between packed models.


name string

Name of the printer-type, such as Fortus 250 or ProJet 660


overhead_per_line_item float

Overhead cost per line item


print_cost_scale_factor integer

A scaling factor multiplied with print cost


running_cost_per_hour float

The cost for running the printer type per hour.


support_strategies array

A list of support strategies URIs that this printer can use.


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

Buffer time after printing process in seconds.


time_before_print integer

Buffer time before printing will start in seconds.


type string

Technology used by the printer such as DLMS or FDM


uri URI

The URI of the printer-type.


Responses
Status CodeDescription
200

The request was successful

400

The requested printer type name already exists.

You cannot delete this printer_type because there are printers associated with it. Delete all printers of this type first.

There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau.

The value you provided for materials does not appear to be a valid material

403

You are not authorized to complete the request.

404

The requested printer type cannot be found.

/printer/

get post

A printer is an instance of a printer-type in a particular location. It should correspond to a physical machine used for printing parts. Printers are used to queue and schedule work and get status information about prints to be performed to satisfy orders

List all of the printer in the system for your account.

Schema (application/json)
PropertyTypeDescription
description string

Description of printer


location URI

The URI of the printer's location.


modeler string

A URI from the Machine Analytics service for a modeler. This URI will be used to capture updates from Machine Analytics and apply the data to this printer


name string

Name of the printer.


printer_type URI

The URI of the printer type.


queue array

Ordered list of run URIs queued on the printer.


Example: '["..."]'
uri URI

The URI of the printer.


Responses
Status CodeDescription
200

The request was successful

400

You cannot change the position of an already printing job.

The requested printer name already exists.

Cannot delete printer that has runs in queue. Remove runs before deleting printer.

403

You are not authorized to complete the request.

404

The requested printer cannot be found.

Create a new printer.

Schema (application/json)
PropertyTypeDescription
description string

Description of printer


Default: None
location URI

The URI of the printer's location.


Required
modeler string

A URI from the Machine Analytics service for a modeler. This URI will be used to capture updates from Machine Analytics and apply the data to this printer


Default: None
name string

Name of the printer.


Required
printer_type URI

The URI of the printer type.


Required
queue array

Ordered list of run URIs queued on the printer.


Default: []
Example: '["..."]'
uri URI

The URI of the printer.


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

The request was successful

400

You cannot change the position of an already printing job.

The requested printer name already exists.

Cannot delete printer that has runs in queue. Remove runs before deleting printer.

403

You are not authorized to complete the request.

404

The requested printer cannot be found.

A printer is an instance of a printer-type in a particular location. It should correspond to a physical machine used for printing parts. Printers are used to queue and schedule work and get status information about prints to be performed to satisfy orders

Get a single printer by UUID.

Schema (application/json)
PropertyTypeDescription
description string

Description of printer


location URI

The URI of the printer's location.


modeler string

A URI from the Machine Analytics service for a modeler. This URI will be used to capture updates from Machine Analytics and apply the data to this printer


name string

Name of the printer.


printer_type URI

The URI of the printer type.


queue array

Ordered list of run URIs queued on the printer.


Example: '["..."]'
uri URI

The URI of the printer.


Responses
Status CodeDescription
200

The request was successful

400

You cannot change the position of an already printing job.

The requested printer name already exists.

Cannot delete printer that has runs in queue. Remove runs before deleting printer.

403

You are not authorized to complete the request.

404

The requested printer cannot be found.

/process-step/

get post

Process Step endpoint offers a way to add steps in a workflow that will be used to process the order. Steps must have either a printer-type, post-processor-type or shipping type that defines their behavior. Steps can also require a technician to provide uploaded data, notes, confirmation of success or other forms of input before the step is completed

List all of the process steps in your bureau

Schema (application/json)
PropertyTypeDescription
is_prosper_integration_available boolean none available
name string

The name of the process_step.


Example: '"ProcessStep-0.1"'
notes string

Does this step need notes from user?


Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
process_type_uri URL

The URI of the process type


step_position integer

Step position in workflow


Example: '"2"'
success string

Does this step need a success validation from user?


Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
tracking_id string

Does this step need a tracking_id from user?


Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
upload string

Does this step need an upload from user?


Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
uri URI

The URI for Process Step resource.


workflow URI

The URI of the workflow for which we have the process_step value.


Responses
Status CodeDescription
200

The request was successful

400

The value of bureau appears to be an invalid bureau.

The requested process_step name already exists.

Cannot delete process-step that belongs to a workflow.

403

You are not authorized to complete the request.

404

The requested process_step cannot be found.

Create a new process step resource.

Schema (application/json)
PropertyTypeDescription
is_prosper_integration_available boolean none available
Default: False
name string

The name of the process_step.


Default: None
Example: '"ProcessStep-0.1"'
notes string

Does this step need notes from user?


Required
Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
process_type_uri URL

The URI of the process type


Required
step_position integer

Step position in workflow


Default: None
Example: '"2"'
success string

Does this step need a success validation from user?


Required
Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
tracking_id string

Does this step need a tracking_id from user?


Required
Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
upload string

Does this step need an upload from user?


Required
Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
uri URI

The URI for Process Step resource.


Default: None
workflow URI

The URI of the workflow for which we have the process_step value.


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

The request was successful

400

The value of bureau appears to be an invalid bureau.

The requested process_step name already exists.

Cannot delete process-step that belongs to a workflow.

403

You are not authorized to complete the request.

404

The requested process_step cannot be found.

Process Step endpoint offers a way to add steps in a workflow that will be used to process the order. Steps must have either a printer-type, post-processor-type or shipping type that defines their behavior. Steps can also require a technician to provide uploaded data, notes, confirmation of success or other forms of input before the step is completed

Get an individual process step resource by UUID.

Schema (application/json)
PropertyTypeDescription
is_prosper_integration_available boolean none available
name string

The name of the process_step.


Example: '"ProcessStep-0.1"'
notes string

Does this step need notes from user?


Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
process_type_uri URL

The URI of the process type


step_position integer

Step position in workflow


Example: '"2"'
success string

Does this step need a success validation from user?


Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
tracking_id string

Does this step need a tracking_id from user?


Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
upload string

Does this step need an upload from user?


Choices
  • optional
  • required
  • hidden
Example: '"Select: optional, required or hidden"'
uri URI

The URI for Process Step resource.


workflow URI

The URI of the workflow for which we have the process_step value.


Responses
Status CodeDescription
200

The request was successful

400

The value of bureau appears to be an invalid bureau.

The requested process_step name already exists.

Cannot delete process-step that belongs to a workflow.

403

You are not authorized to complete the request.

404

The requested process_step cannot be found.

/prosper/

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

Schema (application/json)
PropertyTypeDescription
created iso-8601 datetime

When the cassette resource was created


service_url URL

The URI of the printer performing the build


Choices
  • s
  • e
  • r
  • v
  • i
  • c
  • e
  • _
  • u
  • r
  • l
Example: '"s|e|r|v|i|c|e|_|u|r|l"'
uri URI

The URI for this prosper


x_p3d_token string

The application token Prosper service


x_p3d_user string

The user token of Prosper service


Responses
Status CodeDescription
200

The request was successful

404

The prosper requested cannot be found

Create a new prosper

Schema (application/json)
PropertyTypeDescription
created iso-8601 datetime

When the cassette resource was created


Default: None
service_url URL

The URI of the printer performing the build


Required
Choices
  • s
  • e
  • r
  • v
  • i
  • c
  • e
  • _
  • u
  • r
  • l
Example: '"s|e|r|v|i|c|e|_|u|r|l"'
uri URI

The URI for this prosper


Default: None
x_p3d_token string

The application token Prosper service


Required
x_p3d_user string

The user token of Prosper service


Required
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

The prosper 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 prosper by UUID

Schema (application/json)
PropertyTypeDescription
created iso-8601 datetime

When the cassette resource was created


service_url URL

The URI of the printer performing the build


Choices
  • s
  • e
  • r
  • v
  • i
  • c
  • e
  • _
  • u
  • r
  • l
Example: '"s|e|r|v|i|c|e|_|u|r|l"'
uri URI

The URI for this prosper


x_p3d_token string

The application token Prosper service


x_p3d_user string

The user token of Prosper service


Responses
Status CodeDescription
200

The request was successful

404

The prosper requested cannot be found

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

Get all resources for your account.

Schema (application/json)
PropertyTypeDescription
material_name string

Material name


printer_name string

Printer name


uri URI

URI for object


Responses
Status CodeDescription
200

The request was successful

400

The requested object name already exists.

404

The requested object cannot be found.

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

Get an individual resource by UUID.

Schema (application/json)
PropertyTypeDescription
material_name string

Material name


printer_name string

Printer name


uri URI

URI for object


Responses
Status CodeDescription
200

The request was successful

400

The requested object name already exists.

404

The requested object cannot be found.

/quote/

get post

This is the main resource for Quoting price for printing a model with certain material and from a certain bureau with a currency specified.

No description provided
Schema (application/json)
PropertyTypeDescription
actual_cost float

The actual cost corresponding to a /quote/


Example: '"39.45"'
bureau string

Quote price from this bureau. You get the list of bureaus from GET/bureau/


Choices
  • shapeways
  • materialise
Example: '"shapeways"'
callback object

Callback URL for price quoting result


Example: '{}'
created iso-8601 datetime

Creation date of the quote


Example: '"2017-01-01T00:00:00.000000"'
currency string

Currency of the price quote


Choices
  • USD
Example: '"USD"'
error string

Error message from the bureau


Example: '"Failed to grab pricing data"'
material URI

Quote price for this material using the material URI. You get the list of materials from GET/material/


Example: '"https://quoting.authentise.com/material/123456/"'
model URL

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


Example: '"https://models.authentise.com/model/456/"'
model_statistics object

Model statistics for the model resource.


Example: '{"size": {}}'
price float

Price quote for the model


Example: '"100.00"'
process string

Technology used to print this model.


Choices
  • FDM
  • SLA
  • DLP
  • EBM
  • SDL
  • Binder Jet
Example: '"FDM|SLA|DLP|EBM|SDL|Binder Jet"'
status string

Status code of the request. Possible status are: complete, error, processing, queued.


Example: '"complete"'
uri URI

The URI of the /quote/ instance


Example: '"https://quoting.authentise.com/quote/123456/"'
Responses
Status CodeDescription
200

The request was successful

400

There is no matching bureau-material combination

Either the model requested does not exist or you do not have permission to use

The model response does not contain few or all of these fields: Size, Volume, Surface Area

404

The material requested is not available with the bureau requested

500

The bureau requested does not exist

This resource does the price quoting with valid payload

Schema (application/json)
PropertyTypeDescription
actual_cost float

The actual cost corresponding to a /quote/


Default: None
Example: '"39.45"'
bureau string

Quote price from this bureau. You get the list of bureaus from GET/bureau/


Required
Choices
  • shapeways
  • materialise
Example: '"shapeways"'
callback object

Callback URL for price quoting result


Default: None
Example: '{}'
created iso-8601 datetime

Creation date of the quote


Default: None
Example: '"2017-01-01T00:00:00.000000"'
currency string

Currency of the price quote


Required
Choices
  • USD
Example: '"USD"'
error string

Error message from the bureau


Default: None
Example: '"Failed to grab pricing data"'
material URI

Quote price for this material using the material URI. You get the list of materials from GET/material/


Required
Example: '"https://quoting.authentise.com/material/123456/"'
model URL

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


Required
Example: '"https://models.authentise.com/model/456/"'
model_statistics object

Model statistics for the model resource.


Default: None
Example: '{"size": {}}'
price float

Price quote for the model


Default: None
Example: '"100.00"'
process string

Technology used to print this model.


Default: FDM
Choices
  • FDM
  • SLA
  • DLP
  • EBM
  • SDL
  • Binder Jet
Example: '"FDM|SLA|DLP|EBM|SDL|Binder Jet"'
status string

Status code of the request. Possible status are: complete, error, processing, queued.


Default: None
Example: '"complete"'
uri URI

The URI of the /quote/ instance


Default: None
Example: '"https://quoting.authentise.com/quote/123456/"'
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

400

There is no matching bureau-material combination

Either the model requested does not exist or you do not have permission to use

The model response does not contain few or all of these fields: Size, Volume, Surface Area

404

The material requested is not available with the bureau requested

500

The bureau requested does not exist

This is the main resource for Quoting price for printing a model with certain material and from a certain bureau with a currency specified.

No description provided
Schema (application/json)
PropertyTypeDescription
actual_cost float

The actual cost corresponding to a /quote/


Example: '"39.45"'
bureau string

Quote price from this bureau. You get the list of bureaus from GET/bureau/


Choices
  • shapeways
  • materialise
Example: '"shapeways"'
callback object

Callback URL for price quoting result


Example: '{}'
created iso-8601 datetime

Creation date of the quote


Example: '"2017-01-01T00:00:00.000000"'
currency string

Currency of the price quote


Choices
  • USD
Example: '"USD"'
error string

Error message from the bureau


Example: '"Failed to grab pricing data"'
material URI

Quote price for this material using the material URI. You get the list of materials from GET/material/


Example: '"https://quoting.authentise.com/material/123456/"'
model URL

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


Example: '"https://models.authentise.com/model/456/"'
model_statistics object

Model statistics for the model resource.


Example: '{"size": {}}'
price float

Price quote for the model


Example: '"100.00"'
process string

Technology used to print this model.


Choices
  • FDM
  • SLA
  • DLP
  • EBM
  • SDL
  • Binder Jet
Example: '"FDM|SLA|DLP|EBM|SDL|Binder Jet"'
status string

Status code of the request. Possible status are: complete, error, processing, queued.


Example: '"complete"'
uri URI

The URI of the /quote/ instance


Example: '"https://quoting.authentise.com/quote/123456/"'
Responses
Status CodeDescription
200

The request was successful

400

There is no matching bureau-material combination

Either the model requested does not exist or you do not have permission to use

The model response does not contain few or all of these fields: Size, Volume, Surface Area

404

The material requested is not available with the bureau requested

500

The bureau requested does not exist

Get the data for the various builds captured by the system grouped by modeler

Get all build reports by modeler, or filter by a specific start and end date

Schema (application/json)
PropertyTypeDescription
builds_count integer

The total number of builds


builds_estimated_time integer

The total estimate build time


builds_estimation_error integer

The average amount of estimated build time error


builds_status_complete integer

The number of builds with the complete status


builds_status_failed integer

The number of builds with the failed status


builds_status_machine_error integer

The number of builds with the machine_error status


builds_status_new integer

The number of builds with the new status


builds_status_part_exceeds_boundaries integer

The number of builds with the part_exceeds_boundaries status


builds_status_processing integer

The number of builds with the processing status


builds_status_suspended integer

The number of builds with the suspended status


builds_status_user_abort integer

The number of builds with the user_abort status


builds_time integer

The total amount of build time


modeler string

The modeler identifier


modeler_name string

The modeler name


Responses
Status CodeDescription
200

The request was successful

/role/

get post

Get and update a users role.

Get a list of all users for a bureau and their roles

Schema (application/json)
PropertyTypeDescription
bureau URI

The bureau to adjust the role for


emails array

The user's email address


Example: '["..."]'
location URI

The locations the user is assigned to for this role, or null if the role is not location-based


name string

The name of the user.


role string

The role for the particular user


Choices
  • manager
  • global-user
  • location-user
  • restricted
  • unknown
Example: '"manager|global-user|location-user|restricted|unknown"'
uri URI

The URI of the role


username string

The username of the user


Responses
Status CodeDescription
200

The request was successful

400

BadUser

User already belongs to a bureau

403

You are not authorized to complete the request.

404

The requested role cannot be found.

Create a new role for a user in a bureau

Schema (application/json)
PropertyTypeDescription
bureau URI

The bureau to adjust the role for


Required
emails array

The user's email address


Required
Example: '["..."]'
location URI

The locations the user is assigned to for this role, or null if the role is not location-based


Default: None
name string

The name of the user.


Required
role string

The role for the particular user


Required
Choices
  • manager
  • global-user
  • location-user
  • restricted
  • unknown
Example: '"manager|global-user|location-user|restricted|unknown"'
uri URI

The URI of the role


Required
username string

The username of the user


Required
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

400

BadUser

User already belongs to a bureau

403

You are not authorized to complete the request.

404

The requested role cannot be found.

Get and update a users role.

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

The bureau to adjust the role for


emails array

The user's email address


Example: '["..."]'
location URI

The locations the user is assigned to for this role, or null if the role is not location-based


name string

The name of the user.


role string

The role for the particular user


Choices
  • manager
  • global-user
  • location-user
  • restricted
  • unknown
Example: '"manager|global-user|location-user|restricted|unknown"'
uri URI

The URI of the role


username string

The username of the user


Responses
Status CodeDescription
200

The request was successful

400

BadUser

User already belongs to a bureau

403

You are not authorized to complete the request.

404

The requested role cannot be found.

/run-queue/ endpoint helps requeuing the run provided to the API and puts it in the start of the queue. The API will schedule the run and hence the prints as the next run to be processed.

Requeue runs and make this run read to be processed.

Schema (application/json)
PropertyTypeDescription
run URI

The URI of run's which is to be requeued..


Required
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

The requested run cannot be found.

/run/

get post

A run corresponds to a single run of a printer or post-processor. A run must have one or more prints associated with it. The print identifies the data that was operated on. The system can aggregate multiple prints together for efficiency. A run can be created without a specific printer or post-processor to indicate work that should be done in the future. Eventually the run is assigned to a particular printer or post-processor that completes the run.

Run data can be automatically updated based on reports gathered by Echo. This gives the system a full control loop for data.

Get all of the runs the current user has access to

Schema (application/json)
PropertyTypeDescription
actuals object

The actual measured timing and usage data for this run


Example: '{"time": {}, "materials": {}}'
alt_models array none available
Example: '["..."]'
batch_type string

Type of batching strategy.


Choices
  • by_size_xyz
  • by_size_xy
  • by_number_of_parts
  • match_previous
  • single
Example: '"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single"'
created iso-8601 datetime

The datetime the records was created


error string

The current error for the run, if any


estimates object

Estimated timing and resource usage data for this run


Example: '{"time": {}, "materials": {}, "queue_delay": {}}'
id string

The identifier for this run. This identifier will be generated when the run is created and should be the name used for the print so the sytem can track it


layout URI

The URI of run's layout.


line_item_third_parties array

The URI of prints in the order.


Example: '["..."]'
location URI

The URI of run's location.


locked boolean

When locked, prints in this run cannot be added or removed


model URI

The URI of run's model.


name string

name of a run


notes string

Notes for a run


operation string

Operation type of the run.


Choices
  • printing
  • post-processing
  • shipping
Example: '"printing|post-processing|shipping"'
post_processor URI

The URI of run's post_processor.


post_processor_type URI

The URI of run's post processor type.


printer URI

The URI of run's printer.


printer_type URI

The URI of run's printer type.


prints array

The URI of prints in the order.


Example: '["..."]'
run_documents array none available
Example: '["..."]'
scheduled object

User input as datetime to schedule a run.


Example: '{}'
shipping URI

The URI of run's shipping type.


status string

Status of the run.


Choices
  • calculating
  • calculated
  • queued
  • in-progress
  • complete
  • error
Example: '"calculating|calculated|queued|in-progress|complete|error"'
success boolean

Success: True or False


tracking_id string

Tracking ID for shipping run.


upload string

Uploads for a run.


uri URI

The URI of the run.


Responses
Status CodeDescription
200

The request was successful

400

Run cannot consist of itar, and non-itar line items.

The system is busy printing. Please end the current process first.

The requested prints do not have their associated line_items in either confirmed or printing state.

The requested prints do not have same process types belonging to process steps.

All the previous steps for the order should be completed before we can process these prints.

404

The requested run cannot be found.

409

The requested status transformation is not allowed.

Create a new run.

Schema (application/json)
PropertyTypeDescription
actuals object

The actual measured timing and usage data for this run


Default: None
Example: '{"time": {}, "materials": {}}'
alt_models array none available
Default: []
Example: '["..."]'
batch_type string

Type of batching strategy.


Default: match_previous
Choices
  • by_size_xyz
  • by_size_xy
  • by_number_of_parts
  • match_previous
  • single
Example: '"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single"'
created iso-8601 datetime

The datetime the records was created


Default: None
error string

The current error for the run, if any


Default: None
estimates object

Estimated timing and resource usage data for this run


Default: None
Example: '{"time": {}, "materials": {}, "queue_delay": {}}'
id string

The identifier for this run. This identifier will be generated when the run is created and should be the name used for the print so the sytem can track it


Default: None
layout URI

The URI of run's layout.


Default: None
line_item_third_parties array

The URI of prints in the order.


Required
Example: '["..."]'
location URI

The URI of run's location.


Default: None
locked boolean

When locked, prints in this run cannot be added or removed


Default: True
model URI

The URI of run's model.


Default: None
name string

name of a run


Default: None
notes string

Notes for a run


Default: None
operation string

Operation type of the run.


Default: None
Choices
  • printing
  • post-processing
  • shipping
Example: '"printing|post-processing|shipping"'
post_processor URI

The URI of run's post_processor.


Default: None
post_processor_type URI

The URI of run's post processor type.


Default: None
printer URI

The URI of run's printer.


Default: None
printer_type URI

The URI of run's printer type.


Default: None
prints array

The URI of prints in the order.


Required
Example: '["..."]'
run_documents array none available
Default: None
Example: '["..."]'
scheduled object

User input as datetime to schedule a run.


Default: None
Example: '{}'
shipping URI

The URI of run's shipping type.


Default: None
status string

Status of the run.


Default: None
Choices
  • calculating
  • calculated
  • queued
  • in-progress
  • complete
  • error
Example: '"calculating|calculated|queued|in-progress|complete|error"'
success boolean

Success: True or False


Default: None
tracking_id string

Tracking ID for shipping run.


Default: None
upload string

Uploads for a run.


Default: None
uri URI

The URI of the run.


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

The request was successful

400

Run cannot consist of itar, and non-itar line items.

The system is busy printing. Please end the current process first.

The requested prints do not have their associated line_items in either confirmed or printing state.

The requested prints do not have same process types belonging to process steps.

All the previous steps for the order should be completed before we can process these prints.

404

The requested run cannot be found.

409

The requested status transformation is not allowed.

And internal API for other services to report data about the run

No description provided
Schema (application/json)
PropertyTypeDescription
build_type string none available
Required
build_x_mm float none available
Required
build_y_mm float none available
Required
build_z_mm float none available
Required
callback_method string none available
Required
callback_url URL none available
Required
error string none available
Default: None
fill_percentage float none available
Required
min_packing_distance float none available
Required
status string none available
Required
uri URL none available
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 run cannot be found.

Layout for the run does not exist.

An internal API for other services to report data on a run's model

No description provided
Schema (application/json)
PropertyTypeDescription
callback_method string none available
Required
callback_url URL none available
Required
merged_model URI none available
Required
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

404

The requested run cannot be found.

A run corresponds to a single run of a printer or post-processor. A run must have one or more prints associated with it. The print identifies the data that was operated on. The system can aggregate multiple prints together for efficiency. A run can be created without a specific printer or post-processor to indicate work that should be done in the future. Eventually the run is assigned to a particular printer or post-processor that completes the run.

Run data can be automatically updated based on reports gathered by Echo. This gives the system a full control loop for data.

Get a single run by UUID.

Schema (application/json)
PropertyTypeDescription
actuals object

The actual measured timing and usage data for this run


Example: '{"time": {}, "materials": {}}'
alt_models array none available
Example: '["..."]'
batch_type string

Type of batching strategy.


Choices
  • by_size_xyz
  • by_size_xy
  • by_number_of_parts
  • match_previous
  • single
Example: '"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single"'
created iso-8601 datetime

The datetime the records was created


error string

The current error for the run, if any


estimates object

Estimated timing and resource usage data for this run


Example: '{"time": {}, "materials": {}, "queue_delay": {}}'
id string

The identifier for this run. This identifier will be generated when the run is created and should be the name used for the print so the sytem can track it


layout URI

The URI of run's layout.


line_item_third_parties array

The URI of prints in the order.


Example: '["..."]'
location URI

The URI of run's location.


locked boolean

When locked, prints in this run cannot be added or removed


model URI

The URI of run's model.


name string

name of a run


notes string

Notes for a run


operation string

Operation type of the run.


Choices
  • printing
  • post-processing
  • shipping
Example: '"printing|post-processing|shipping"'
post_processor URI

The URI of run's post_processor.


post_processor_type URI

The URI of run's post processor type.


printer URI

The URI of run's printer.


printer_type URI

The URI of run's printer type.


prints array

The URI of prints in the order.


Example: '["..."]'
run_documents array none available
Example: '["..."]'
scheduled object

User input as datetime to schedule a run.


Example: '{}'
shipping URI

The URI of run's shipping type.


status string

Status of the run.


Choices
  • calculating
  • calculated
  • queued
  • in-progress
  • complete
  • error
Example: '"calculating|calculated|queued|in-progress|complete|error"'
success boolean

Success: True or False


tracking_id string

Tracking ID for shipping run.


upload string

Uploads for a run.


uri URI

The URI of the run.


Responses
Status CodeDescription
200

The request was successful

400

Run cannot consist of itar, and non-itar line items.

The system is busy printing. Please end the current process first.

The requested prints do not have their associated line_items in either confirmed or printing state.

The requested prints do not have same process types belonging to process steps.

All the previous steps for the order should be completed before we can process these prints.

404

The requested run cannot be found.

409

The requested status transformation is not allowed.

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

No description provided

/schedule_runs/

get post

API endpoint to trigger schdule estimation. This will cause the backend to run a recursive search/scan to create a schedule starting from the selected run URI. This may change state or schedule of other Schedule.

responds to API REST GET with no UUID, to get a list of all entries. @returns tuple of (data, status_code, extra headers)

Schema (application/json)
PropertyTypeDescription
estimates object

Estimated timing and resource usage data for this run


Example: '{"time": {}, "materials": {}, "queue_delay": {}}'
run URI

URI of run we want to the est operation performed


uri URI

URI of estimate object


Responses
Status CodeDescription
200

The request was successful

400

Wait until estimation process for this run will finish

responds to API REST POST. Creates a new run_estimate from payload @returns tuple of (data, status_code, ??)

Schema (application/json)
PropertyTypeDescription
estimates object

Estimated timing and resource usage data for this run


Default: None
Example: '{"time": {}, "materials": {}, "queue_delay": {}}'
run URI

URI of run we want to the est operation performed


Required
uri URI

URI of estimate object


Required
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

400

Wait until estimation process for this run will finish

API endpoint to trigger schdule estimation. This will cause the backend to run a recursive search/scan to create a schedule starting from the selected run URI. This may change state or schedule of other Schedule.

responds to API REST GET , gets single entry from db @returns tuple of (data, status_code, ??)

Schema (application/json)
PropertyTypeDescription
estimates object

Estimated timing and resource usage data for this run


Example: '{"time": {}, "materials": {}, "queue_delay": {}}'
run URI

URI of run we want to the est operation performed


uri URI

URI of estimate object


Responses
Status CodeDescription
200

The request was successful

400

Wait until estimation process for this run will finish

ServiceProvider helps to store the 3rd party service provider information.

List all of the service-provider in the system for your account.

Schema (application/json)
PropertyTypeDescription
address string

Address of service-provider


bureau URI

The URI of the bureau for service-provider.


contact string

Contact name for service-provider


materials array

The URI of materials the service provider wants to work with.


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

Name of the service-provider.


phone string

Phone number for service-provider.


uri URI

The URI of the service-provider.


Responses
Status CodeDescription
200

The request was successful

400

The requested service provider name already exists.

403

You are not authorized to complete the request.

404

The requested service-provider cannot be found.

Create a new service-provider.

Schema (application/json)
PropertyTypeDescription
address string

Address of service-provider


Required
bureau URI

The URI of the bureau for service-provider.


Required
contact string

Contact name for service-provider


Required
materials array

The URI of materials the service provider wants to work with.


Required
Example: '["..."]'
name string

Name of the service-provider.


Required
phone string

Phone number for service-provider.


Required
uri URI

The URI of the service-provider.


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

The request was successful

400

The requested service provider name already exists.

403

You are not authorized to complete the request.

404

The requested service-provider cannot be found.

ServiceProvider helps to store the 3rd party service provider information.

Get a single service-provider.

Schema (application/json)
PropertyTypeDescription
address string

Address of service-provider


bureau URI

The URI of the bureau for service-provider.


contact string

Contact name for service-provider


materials array

The URI of materials the service provider wants to work with.


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

Name of the service-provider.


phone string

Phone number for service-provider.


uri URI

The URI of the service-provider.


Responses
Status CodeDescription
200

The request was successful

400

The requested service provider name already exists.

403

You are not authorized to complete the request.

404

The requested service-provider cannot be found.

/sessions/

get post

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

No description provided
Schema (application/json)
PropertyTypeDescription
emails array none available
Example: '[{}]'
ephemeral boolean none available
impersonating URI none available
name string none available
password string none available
submit string none available
tos boolean none available
uri URI none available
username string none available
Responses
Status CodeDescription
200

The request was successful

No description provided
Schema (application/json)
PropertyTypeDescription
emails array none available
Default: []
Example: '[{}]'
ephemeral boolean none available
Default: False
impersonating URI none available
Default: None
name string none available
Default: None
password string none available
Required
submit string none available
Default: None
tos boolean none available
Default: False
uri URI none available
Default: None
username string none available
Required
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

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

No description provided
Schema (application/json)
PropertyTypeDescription
emails array none available
Example: '[{}]'
ephemeral boolean none available
impersonating URI none available
name string none available
password string none available
submit string none available
tos boolean none available
uri URI none available
username string none available
Responses
Status CodeDescription
200

The request was successful

/shipping/

get post

Shipping endpoint has all the available shipping resource for a bureau and region. The total cost for a shipping an order is then calculate using the unit cost for shipping with the currency conversion for the involved order currency.

List all of the shipping in the system for your account.

Schema (application/json)
PropertyTypeDescription
batching_strategy string

Batching Strategy which describe how should be grouped Prints for Run with this Shipping.


Choices
  • by_size_xyz
  • by_size_xy
  • by_number_of_parts
  • match_previous
  • single
Example: '"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single"'
build_volume object

Dimensions of the build volume in millimeters. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


Example: '{}'
bureau URI

The URI of the bureau for which we have the shipping value.


cost float

The unit cost of shipping.


description string

The name of the shipping.


Example: '"Standard Shipping"'
min_packing_distance float

Min distance between Parts. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


name string

The description of the shipping.


Example: '"Standard fixed cost shipping"'
number_of_parts integer

Max number of Prints in Run. Used when batching_strategy == 'by_number_of_parts'


region string

Select a region from the list: ['africa', 'antarctica', 'asia', 'australia', 'europe', 'north-america', 'south-america']


Choices
  • africa
  • antarctica
  • asia
  • australia
  • europe
  • north-america
  • south-america
Example: '"africa|antarctica|asia|australia|europe|north-america|south-america"'
uri URI

The URI for shipping resource.


Responses
Status CodeDescription
200

The request was successful

400

The value of bureau appears to be an invalid bureau.

The requested shipping name for the region already exists.

invalid-payload: Missed required fields for provided Batching Strategy.

Cannot delete shipping that has runs in queue. Remove runs before deleting shipping.

403

You are not authorized to complete the request.

404

The requested shipping cannot be found.

Create a new shipping resource.

Schema (application/json)
PropertyTypeDescription
batching_strategy string

Batching Strategy which describe how should be grouped Prints for Run with this Shipping.


Default: single
Choices
  • by_size_xyz
  • by_size_xy
  • by_number_of_parts
  • match_previous
  • single
Example: '"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single"'
build_volume object

Dimensions of the build volume in millimeters. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


Required
Example: '{}'
bureau URI

The URI of the bureau for which we have the shipping value.


Required
cost float

The unit cost of shipping.


Required
description string

The name of the shipping.


Required
Example: '"Standard Shipping"'
min_packing_distance float

Min distance between Parts. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


Default: None
name string

The description of the shipping.


Required
Example: '"Standard fixed cost shipping"'
number_of_parts integer

Max number of Prints in Run. Used when batching_strategy == 'by_number_of_parts'


Default: None
region string

Select a region from the list: ['africa', 'antarctica', 'asia', 'australia', 'europe', 'north-america', 'south-america']


Required
Choices
  • africa
  • antarctica
  • asia
  • australia
  • europe
  • north-america
  • south-america
Example: '"africa|antarctica|asia|australia|europe|north-america|south-america"'
uri URI

The URI for shipping resource.


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

The request was successful

400

The value of bureau appears to be an invalid bureau.

The requested shipping name for the region already exists.

invalid-payload: Missed required fields for provided Batching Strategy.

Cannot delete shipping that has runs in queue. Remove runs before deleting shipping.

403

You are not authorized to complete the request.

404

The requested shipping cannot be found.

Shipping endpoint has all the available shipping resource for a bureau and region. The total cost for a shipping an order is then calculate using the unit cost for shipping with the currency conversion for the involved order currency.

Get an individual shipping resource by UUID.

Schema (application/json)
PropertyTypeDescription
batching_strategy string

Batching Strategy which describe how should be grouped Prints for Run with this Shipping.


Choices
  • by_size_xyz
  • by_size_xy
  • by_number_of_parts
  • match_previous
  • single
Example: '"by_size_xyz|by_size_xy|by_number_of_parts|match_previous|single"'
build_volume object

Dimensions of the build volume in millimeters. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


Example: '{}'
bureau URI

The URI of the bureau for which we have the shipping value.


cost float

The unit cost of shipping.


description string

The name of the shipping.


Example: '"Standard Shipping"'
min_packing_distance float

Min distance between Parts. Used when batching_strategy in ('by_size_xy', 'by_size_xyz')


name string

The description of the shipping.


Example: '"Standard fixed cost shipping"'
number_of_parts integer

Max number of Prints in Run. Used when batching_strategy == 'by_number_of_parts'


region string

Select a region from the list: ['africa', 'antarctica', 'asia', 'australia', 'europe', 'north-america', 'south-america']


Choices
  • africa
  • antarctica
  • asia
  • australia
  • europe
  • north-america
  • south-america
Example: '"africa|antarctica|asia|australia|europe|north-america|south-america"'
uri URI

The URI for shipping resource.


Responses
Status CodeDescription
200

The request was successful

400

The value of bureau appears to be an invalid bureau.

The requested shipping name for the region already exists.

invalid-payload: Missed required fields for provided Batching Strategy.

Cannot delete shipping that has runs in queue. Remove runs before deleting shipping.

403

You are not authorized to complete the request.

404

The requested shipping cannot be found.

/slice/

get post

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

No description provided
Schema (application/json)
PropertyTypeDescription
callback object none available
Example: '{"method": "POST|PUT|GET"}'
config URI none available
content string none available
error string none available
estimated_slicing_time_ms integer none available
estimates object none available
Example: '{}'
model string none available
slice_time string none available
status string none available
uri