Machine – 3D Spark Blog

The utilized machine in a process chain greatly affects the process chain calculation, especially regarding printability (size feasibility), process step time of the build process and cost of this main process step in the chain.

Request Machine by ID (GET)

Get machine information.

Return Data

Parameter	Description	Type	Example
mac_id	Machine UUID	string	“c3bf2c486f384a34bf512dd512e67dc3”
owner_username	Username of machine owner	string, null	“arnd”
restriction	Restriction level	string, null	“owner”
mac_name	Machine name	string	“Figure 4 Standalone”
oem_name	Brand or manufacturer name	string	“3D Systems”
prc_acronym	Process acronym	string	“dls”
bld_size_x	Build envelope x-direction	float	124
bld_size_y	Build envelope y-direction	float	70
bld_size_z	Build envelope z-direction	float	196
mac_prc_t_plyr	Process time per layer. E.g. recoating or heating time, when the machine tool is inactive.	float	2.75
mac_cost_ph	Machine hourly rate	float	4
fix_mac_cost_pj	Fixed machine cost per job, e.g. consumables.	float	3
setup_time	Time required to manually setup the machine.	float	0.083333
unloading_time	Time required to manually unload the machine till the next setup cycle can be started.	float	0.083333
mac_idl_t_pj	Machine idle time, e.g. preheating and cooling.	float	0
staff_time_factor	Percentage of the build time the machine has to be supervised by personell.	float	0.05
power_consumption	Power consumption	float	0.5

Access

Owner	Restriction	User	Team	External
None	null \| ‘organization’ \| ‘owner’	true	true	true
user	null	true	true	true
user	‘organization’	true	true	false
user	‘owner’	true	false	false

Errors

Precondition	Status code	Error message
mac_id is a valid uuid	422	Invalid user input.
User has read access rights to the machine	403	Access forbidden.
Machine with mac_id can be found in database	404	Object not found in database.

Usage

// GET "https://platform.3dspark.de/api/v1/machine/<mac_id>/"

this.axiosInstance
  .get("/api/v1/machine/c3bf2c486f384a34bf512dd512e67dc3/")
  .then((response) => {
    console.log(response.data);
  })

Request Machine List (GET)

Request all available machines.

Return Data

List of machine items. See ‘Request Machine by ID (GET)’.

Example

// GET "https://platform.3dspark.de/api/v1/machine-list/"

this.axiosInstance
  .get("/api/v1/machine-list/")
  .then((response) => {
    console.log(response.data);
  })

Create Machine (POST)

Create a new machine.

Form Data

Parameter	Description	Required	Type	Unit	Valid Values	Default
mac_name	Machine name	true	string	–	1 – 250 characters	–
oem_name	Brand or manufacturer name	true	string	–	1 – 250 characters	–
restriction	Restriction level.	false	string	–	“owner”, “organization”	“owner”
prc_acronym	Acronym of associated process type	true	string	–	“fdm”, “sla”, “dlp”, “dls”, “sls”, “mjf”, “pjm”, “dod”, “bj”, “slm”, “ebm”, “lmm”, “waam”	–
bld_size_x	Build envelope x-direction	true	float	mm	0.1 – 100000	–
bld_size_y	Build envelope y-direction	true	float	mm	0.1 – 100000	–
bld_size_z	Build envelope z direction	true	float	mm	0.1 – 100000	–
mac_prc_t_plyr	Process time per layer. E.g. recoating or heating time, when the machine tool is inactive.	false	string	s	0 – 100000	0
mac_cost_ph	Machine hourly rate	true	float	€/h	0.1 – 100000	–
fix_mac_cost_pj	Fixed machine cost per job, e.g. consumables.	false	float	€	0 – 100000	0
setup_time	Time required to manually setup the machine.	false	float	h	0 – 100000	0
unloading_time	Time required to manually unload the machine till the next setup cycle can be started.	false	float	h	0 – 100000	0
mac_idl_t_pj	Machine idle time, e.g. preheating and cooling.	false	float	h	0 – 100000	0
staff_time_factor	Percentage of the build time the machine has to be supervised by personell.	false	float	–	0 – 1.0	0
power_consumption	Power consumption	false	float	kW	0 – 100000	null

Errors

Precondition	Status code	Error message
Form data are valid	422	Invalid user input.

Usage

// POST "https://platform.3dspark.de/api/v1/machine/"

let formData = {
  "mac_name": "My Machine",
  "oem_name": "3D Spark",
  // "restriction": "owner",
  "prc_acronym": "fdm",
  "bld_size_x": 251,
  "bld_size_y": 252,
  "bld_size_z": 253,
  // "mac_prc_t_plyr": 5.2,
  "mac_cost_ph": 5.2,
  // "fix_mac_cost_pj": 5.2,
  // "setup_time": 1.0,
  // "unloading_time": 0.5,
  // "mac_idl_t_pj": 0.25,
  // "staff_time_factor": 0.1,   
}
this.axiosInstance
  .post("/api/v1/machine/", formData)
  .then((response) => {
    console.log(response.data);
  })

Return Data

See ‘Request Machine by ID (GET)’

Errors

Precondition	Status code	Error message
Formdata valid	422	Invalid user input.

Edit Machine (PUT)

Edit an existing machine.

Form Data

At least one valid parameter. See ‘Create Machine (POST)’

Return Data

See ‘Request Machine by ID (GET)’

Errors

Precondition	Status code	Error message
Formdata valid	422	Invalid user input.
A mat_id is passed.	400	No machine id given.
User is manager of owner’s organization or owner itself.	403	Access forbidden.

Usage

// PUT "https://platform.3dspark.de/api/v1/machine/<mac_id>/"

let formData = {
  "mac_name": "My Machine",
  // "oem_name": "3D Spark",
  // "restriction": "owner",
  // "prc_acronym": "fdm",
  // "bld_size_x": 251,
  // "bld_size_y": 252,
  // "bld_size_z": 253,
  // "mac_prc_t_plyr": 5.2,
  // "mac_cost_ph": 5.2,
  // "fix_mac_cost_pj": 5.2,
  // "setup_time": 1.0,
  // "unloading_time": 0.5,
  // "mac_idl_t_pj": 0.25,
  // "staff_time_factor": 0.1,   
}
this.axiosInstance
  .put("/api/v1/machine/", formData)
  .then((response) => {
    console.log(response.data);
  })

Delete Machine (POST)

Delete machine.

Return Data

Success notification.

Errors

Precondition	Status code	Error message
A mat_id is passed.	400	No machine id given.
User is manager of owner’s organization or owner itself of the machine	403	Access forbidden.

Usage

// DELETE "https://platform.3dspark.de/api/v1/machine/<mac_id>/"

this.axiosInstance
  .delete("/api/v1/machine/c3bf2c486f384a34bf512dd512e67dc3/")
  .then((response) => {
    console.log(response.data);
  })