Machine

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
ParameterDescriptionTypeExample
mac_idMachine UUIDstring“c3bf2c486f384a34bf512dd512e67dc3”
owner_usernameUsername of machine ownerstring, null“arnd”
restrictionRestriction levelstring, null“owner”
mac_nameMachine namestring“Figure 4 Standalone”
oem_nameBrand or manufacturer namestring“3D Systems”
prc_acronymProcess acronymstring“dls”
bld_size_xBuild envelope x-directionfloat124
bld_size_yBuild envelope y-directionfloat70
bld_size_zBuild envelope z-directionfloat196
mac_prc_t_plyrProcess time per layer. E.g. recoating or heating time, when the machine tool is inactive.float2.75
mac_cost_phMachine hourly ratefloat4
fix_mac_cost_pjFixed machine cost per job, e.g. consumables.float3
setup_timeTime required to manually setup the machine.float0.083333
unloading_timeTime required to manually unload the machine till the next setup cycle can be started.float0.083333
mac_idl_t_pjMachine idle time, e.g. preheating and cooling.float0
staff_time_factorPercentage of the build time the machine has to be supervised by personell.float0.05
Access
OwnerRestrictionUserTeamExternal
Nonenull | ‘organization’ | ‘owner’truetruetrue
usernulltruetruetrue
user‘organization’truetruefalse
user‘owner’truefalsefalse
Errors
PreconditionStatus codeError message
mac_id is a valid uuid422Invalid user input.
User has read access rights to the machine403Access forbidden.
Machine with mac_id can be found in database404Object 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
ParameterDescriptionRequiredTypeUnitValid ValuesDefault
mac_nameMachine nametruestring1 – 250 characters
oem_nameBrand or manufacturer nametruestring1 – 250 characters
restrictionRestriction level.falsestring“owner”, “organization”“owner”
prc_acronymAcronym of associated process typetruestring“fdm”, “sla”, “dlp”, “dls”, “sls”, “mjf”, “pjm”, “dod”, “bj”, “slm”, “ebm”, “lmm”, “waam”
bld_size_xBuild envelope x-directiontruefloatmm0.1 – 100000
bld_size_yBuild envelope y-directiontruefloatmm0.1 – 100000
bld_size_zBuild envelope z directiontruefloatmm0.1 – 100000
mac_prc_t_plyrProcess time per layer. E.g. recoating or heating time, when the machine tool is inactive.falsestrings0 – 1000000
mac_cost_phMachine hourly ratetruefloat€/h0.1 – 100000
fix_mac_cost_pjFixed machine cost per job, e.g. consumables.falsefloat0 – 1000000
setup_timeTime required to manually setup the machine.falsefloath0 – 1000000
unloading_timeTime required to manually unload the machine till the next setup cycle can be started.falsefloath0 – 1000000
mac_idl_t_pjMachine idle time, e.g. preheating and cooling.falsefloath0 – 1000000
staff_time_factorPercentage of the build time the machine has to be supervised by personell.falsefloat0 – 1.00
Errors
PreconditionStatus codeError message
Form data are valid422Invalid 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
PreconditionStatus codeError message
Formdata valid422Invalid 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
PreconditionStatus codeError message
Formdata valid422Invalid user input.
A mat_id is passed.400No machine id given.
User is manager of owner’s organization or owner itself.403Access 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
PreconditionStatus codeError message
A mat_id is passed.400No machine id given.
User is manager of owner’s organization or owner itself of the machine403Access 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);
  })