Common data model¶
Printer related¶
Printer State¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
String |
A textual representation of the current state of the printer, e.g. “Operational” or “Printing” |
|
1 |
Printer state flags |
A few boolean printer state flags |
|
1 |
Boolean |
|
|
1 |
Boolean |
|
|
1 |
Boolean |
|
|
1 |
Boolean |
|
|
1 |
Boolean |
|
|
1 |
Boolean |
|
|
1 |
Boolean |
|
|
1 |
Boolean |
|
|
1 |
Boolean |
|
Temperature Data¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
Number |
Current temperature |
|
1 |
Number |
Target temperature, may be |
|
0..1 |
Number |
Currently configured temperature offset to apply, will be left out for historic temperature information. |
Historic Temperature Data Point¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
Unix Timestamp |
Timestamp of this data point |
|
0..* |
Temperature stats for tool n. Enumeration starts at 0 for the first tool. Not included if querying only bed state. |
|
|
0..* |
Temperature stats for the printer’s heated bed. Not included if querying only tool state. |
Temperature offset¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
0..1 |
Number |
Temperature offset for tool n. Enumeration starts at 0 for the first tool. |
|
0..1 |
Number |
Temperature offset for the printer’s heated bed. |
Resend stats¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
int |
Number of resend requests received since connecting. |
|
1 |
int |
Number of transmitted lines since connecting. |
|
1 |
int |
Percentage of resend requests vs transmitted lines. Value between 0 and 100. |
Job related¶
Job information¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
The file that is the target of the current print job |
|
|
0..1 |
Float |
The estimated print time for the file, in seconds. |
|
0..1 |
Float |
The print time of the last print of the file, in seconds. |
|
0..1 |
Object |
Information regarding the estimated filament usage of the print job |
|
0..1 |
Float |
Length of filament used, in mm |
|
0..1 |
Float |
Volume of filament used, in cm³ |
Progress information¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
Float |
Percentage of completion of the current print job |
|
1 |
Integer |
Current position in the file being printed, in bytes from the beginning |
|
1 |
Integer |
Time already spent printing, in seconds |
|
1 |
Integer |
Estimate of time left to print, in seconds |
|
1 |
String |
Origin of the current time left estimate. Can currently be either of:
|
File related¶
File information¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
String |
The name of the file without path. E.g. “file.gco” for a file “file.gco” located anywhere in the file system. Currently this will always fit into ASCII. |
|
1 |
String |
The name of the file without the path, this time potentially with non-ASCII unicode characters. E.g. “a turtle 🐢.gco” for a file “a_turtle_turtle.gco” located anywhere in the file system. |
|
1 |
String |
The path to the file within the location. E.g. “folder/subfolder/file.gco” for a file “file.gco” located within “folder” and “subfolder” relative to the root of the location. Currently this will always fit into ASCII. |
|
1 |
String |
Type of file. |
|
1 |
list |
Path to type of file in extension tree. E.g. |
|
0..1 |
String |
User who uploaded the file/created the folder, if this information is available. |
Additional properties depend on type
.
For a type
value of folder
, see Folders.
For any other value see Files.
Folders¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
0..* |
Array of File information items |
Contained children for entries of type |
|
0..1 |
Number |
The size of all files contained in the folder and its subfolders. Not present in non recursive listings! |
Files¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
0..1 |
String |
MD5 hash of the file. Only available for |
|
0..1 |
Number |
The size of the file in bytes. Only available for |
|
0..1 |
Unix timestamp |
The timestamp when this file was uploaded. Only available for |
|
1 |
String, either |
The origin of the file, |
|
0..1 |
References relevant to this file, left out in abridged version |
|
|
0..1 |
Information from the analysis of the GCODE file, if available. Left out in abridged version. |
|
|
0..1 |
Information about previous prints of the file. Left out if the file has never been printed. |
|
|
0..1 |
Statistics about the file, based on the previous print times. Left out if the file has never been printed. |
Abridged file or folder information¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
String |
The name of the file or folder without path. E.g. “file.gco” for a file “file.gco” located anywhere in the file system. Currently this will always fit into ASCII. |
|
1 |
String |
The name of the file without the path, this potentially with non-ASCII unicode characters. E.g. “a turtle 🐢.gco” for a file “a_turtle_turtle.gco” located anywhere in the file system. |
|
1 |
String |
The path to the file or folder within the location. E.g. “folder/subfolder/file.gco” for a file “file.gco” located within “folder” and “subfolder” relative to the root of the location. Currently this will always fit into ASCII. |
|
1 |
String, either |
The origin of the file, |
|
0..1 |
References relevant to this file or folder, left out in abridged version |
GCODE analysis information¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
0..1 |
Float |
The estimated print time of the file, in seconds |
|
0..1 |
Object |
The estimated usage of filament |
|
0..1 |
Float |
The length of filament used, in mm |
|
0..1 |
Float |
The volume of filament used, in cm³ |
|
0..1 |
Object |
Information regarding the size of the printed model |
|
0..1 |
Float |
The depth of the printed model, in mm |
|
0..1 |
Float |
The height of the printed model, in mm |
|
0..1 |
Float |
The width of the printed model, in mm |
|
0..1 |
Object |
Information regarding the size of the printing area |
|
0..1 |
Float |
The maximum X coordinate of the printed model, in mm |
|
0..1 |
Float |
The maximum Y coordinate of the printed model, in mm |
|
0..1 |
Float |
The maximum Z coordinate of the printed model, in mm |
|
0..1 |
Float |
The minimum X coordinate of the printed model, in mm |
|
0..1 |
Float |
The minimum Y coordinate of the printed model, in mm |
|
0..1 |
Float |
The minimum Z coordinate of the printed model, in mm |
|
0..1 |
Object |
Information regarding the bounding box of all moves |
|
0..1 |
Float |
The maximum X coordinate of all moves, in mm |
|
0..1 |
Float |
The maximum Y coordinate of all moves, in mm |
|
0..1 |
Float |
The maximum Z coordinate of all moves, in mm |
|
0..1 |
Float |
The minimum X coordinate of all moves, in mm |
|
0..1 |
Float |
The minimum Y coordinate of all moves, in mm |
|
0..1 |
Float |
The minimum Z coordinate of all moves, in mm |
|
0..1 |
Object |
Information regarding the size of the travel area |
|
0..1 |
Float |
The depth of the travel area, in mm |
|
0..1 |
Float |
The height of the travel area, in mm |
|
0..1 |
Float |
The width of the travel area, in mm |
References¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
URL |
The resource that represents the file or folder (e.g. for issuing commands to or for deleting) |
|
0..1 |
URL |
The download URL for the file. Never present for folders. |
|
0..1 |
URL |
The model from which this file was generated (e.g. an STL, currently not used). Never present for folders. |
Print History¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
Number |
Number of successful prints |
|
1 |
Number |
Number of failed prints |
|
1 |
Unix Timestamp |
Last date this file was printed |
|
1 |
Float |
Last print time in seconds |
|
1 |
Boolean |
Whether the last print was a success or not |
Print Statistics¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
Object |
Object that maps printer profile names to the last print time of the file, in seconds |
|
1 |
Object |
Object that maps printer profile names to the average print time of the file, in seconds |
Access control¶
User record¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
string |
The user’s name |
|
1 |
bool |
Whether the user’s account is active (true) or not (false) |
|
1 |
bool |
Whether the user has user rights. Should always be true. Deprecated as of 1.4.0, use the |
|
1 |
bool |
Whether the user has admin rights (true) or not (false). Deprecated as of 1.4.0, use the |
|
0..1 |
string |
The user’s personal API key |
|
1 |
object |
The user’s personal settings, might be an empty object. |
|
1..n |
List of string |
Groups assigned to the user |
|
1 |
Effective needs of the user |
|
|
0..n |
List of Permissions |
The list of permissions assigned to the user (note: this does not include implicit permissions inherit from groups). |
Permission record¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
string |
The permission’s identifier |
|
1 |
string |
The permission’s name |
|
1 |
boolean |
Whether the permission should be considered dangerous due to a high responsibility (true) or not (false). |
|
1 |
List of string |
List of group identifiers for which this permission is enabled by default |
|
1 |
string |
Human readable description of the permission |
|
1 |
Needs assigned to the permission |
Group record¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
1 |
string |
The group’s identifier |
|
1 |
string |
The group’s name |
|
1 |
string |
A human readable description of the group |
|
0..n |
List of Permissions |
The list of permissions assigned to the group (note: this does not include implicit permissions inherited from subgroups). |
|
0..n |
List of Groups |
Subgroups assigned to the group |
|
1 |
Effective needs of the group |
|
|
1 |
boolean |
Whether this is a default group (true) or not (false) |
|
1 |
boolean |
Whether this group can be removed (true) or not (false) |
|
1 |
boolean |
Whether this group can be modified (true) or not (false) |
|
1 |
boolean |
Whether this group can be assigned to users or other groups (true) or not (false) |
Needs¶
Name |
Multiplicity |
Type |
Description |
---|---|---|---|
|
0..1 |
List of string |
List of |
|
0..1 |
List of string |
List of |