Enfocus Griffin Auto API ({{version}})

Download OpenAPI specification:

NOTE: Support for the XML format in requests and responses is deprecated and will be removed in a future release.

Griffin Info API

Griffin app details

Get capabilities info

Responses

Response samples

Content type
application/json
{
  • "artwork-limit": 0,
  • "sheet-height": "string"
}

Get version info

Responses

Response samples

Content type
application/json
{
  • "app-name": "string",
  • "edition-name": "string",
  • "version-number": "string"
}

Jobs API

Job automation

Get a list of all projects

Responses

Response samples

Content type
[
  • {
    }
]

Create a new project

Request Body schema:
id
required
string

Job ID

name
string

Job name

contact
string

Job contact person

phone
string

Job phone number

client
string

Job client name

notes
string

Job notes

units
string

Job units

ignore-user-units
boolean
Default: false

Enable this option to ignore the predefined PDF user units in artworks

idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

Responses

Request samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "contact": "string",
  • "phone": "string",
  • "client": "string",
  • "notes": "string",
  • "units": "string",
  • "ignore-user-units": false,
  • "idref": 0
}

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Get all artwork pieces in the current job

path Parameters
jobid
required
string

ID of the job

Responses

Response samples

Content type
[
  • {
    }
]

Create new artwork

path Parameters
jobid
required
string

ID of the job

Request Body schema:
artwork
string

Path to artwork file to use for front-side content on this artwork piece

page
integer <int32>

Page of artwork to use for front-side content on this artwork piece, defaults to page 1 when not defined

back-content
string
Enum: "None" "Front" "Mirrored"

Path to artwork file for back-side content when backside type is Artwork

back-artwork
string

Path to artwork file for back-side content when back content type is Artwork

back-page
integer <int32>

Page of back artwork file to use for back-side content when back content type is Artwork

quantity
integer <int32>

Quantity of this artwork piece to produce

flutes
string
Enum: "Horizontal" "Vertical" "Consistent" "None"

Flutes direction of artwork if any

width
string

Width to scale artwork to either as scalar value or percentage of original artwork size

height
string

Height to scale artwork to either as scalar value or percentage of original artwork size

shape-handling
string
Enum: "Largest" "Multiple"

Shape handling mode to use when finding closed path shapes from the dielines in the artwork. 'Multiple' mode will create a new artwork item for each closed path shape detected in the artwork.

scale-proportionally
boolean

Whether to scale proportionally when either width or height are not specified. When false, only the dimension that is specified is scaled. Defaults to false.

bleed-type
string
Enum: "Offset" "None"

Artwork bleed clipping mask type

bleed-offset
string

Offset amount from artwork piece shape to clip the artwork content when bleed type is Offset

spacing-type
string
Enum: "Tool" "Bleed" "Offset"

Spacing type used during nesting to ensure this artwork piece is placed far enough away from others

spacing-offset
string

Spacing offset amount from artwork piece shape when spacing type is Offset

Array of objects (ToolEntity)

Tool types and corresponding mappings used to map paths in the artwork content or artwork dimensions to the correct tool type. The first tool in this list with category 'Cut' is used as the default cutting tool for cases where there are no artwork paths and artwork content box is used as dieshape

Array of objects (BarcodeMarkEntity)

Barcodes to apply to this artwork

Array of objects (Corner Mark)

Corner to apply to this artwork

Array of objects (FillMarkEntity)

Fill marks to apply to this artwork

Array of objects (Grommet Mark)

Grommet marks to apply to this artwork

Array of objects (TextMarkEntity)

Text marks to apply to this artwork

object (TilingEntity)

Tiling preset defining how tiling is performed

Responses

Request samples

Content type
{
  • "artwork": "string",
  • "page": 0,
  • "back-content": "None",
  • "back-artwork": "string",
  • "back-page": 0,
  • "quantity": 0,
  • "flutes": "Horizontal",
  • "width": "string",
  • "height": "string",
  • "shape-handling": "Largest",
  • "scale-proportionally": true,
  • "bleed-type": "Offset",
  • "bleed-offset": "string",
  • "spacing-type": "Tool",
  • "spacing-offset": "string",
  • "tools": [
    ],
  • "barcode-marks": [
    ],
  • "corner-marks": [
    ],
  • "fill-marks": [
    ],
  • "grommet-marks": [
    ],
  • "text-marks": [
    ],
  • "tiling": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Get artwork at index {artworkindex}

path Parameters
artworkindex
required
integer <int32>
jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "index": 0,
  • "name": "string",
  • "quantity": 0,
  • "flutes": "Horizontal",
  • "width": "string",
  • "height": "string",
  • "spacing-type": "Tool",
  • "placed": 0,
  • "front": {
    },
  • "back": {
    },
  • "layouts": [
    ]
}

Delete artwork with index {artworkindex} from the job

path Parameters
artworkindex
required
integer <int32>
jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Run image tracing

path Parameters
artworkindex
required
integer <int32>
jobid
required
string

ID of the job

Request Body schema:
tool-type
required
string

Cutting tool type to use for the generated cut tool path

quality
number <double>

Quality of the raster image to use for generating the cut tool path. A value of 100% will rasterize the image at full size up to a limit of 10 megapixels. Lower values will scale the image down for faster processing and in some case preferred results as less detail is used for tracing.

tolerance
number <double>

Amount of color difference to allow before adjacent colors are considered different. A value of 0% means no tolerance in color differences is allowed while 100% is the maximum allowed tolerance in color differences.

blur-radius
number <double>

The amount of blurring to apply to edges that are encountered during edge detection. A higher blur radius means more blurring is applied during edge detection which can lead to less jagged paths.

simplify
number <double>

The amount of simplification to apply to the generated path. Simplify works by removing points on the path that are within a certain tolerance. A value of 0% disables path simplification while a value of 100% will use the highest allowed tolerance when removing points.

smoothing
number <double>

Smoothing converts individual points on the generated path to Bezier curves to produce smoother paths. A value of 0% disables path smoothing while a value of 100% will perform the most aggressive path curve smoothing.

offset
string

Additional offset distance to expand the generated path.

idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

Responses

Request samples

Content type
{
  • "tool-type": "string",
  • "quality": 0.1,
  • "tolerance": 0.1,
  • "blur-radius": 0.1,
  • "simplify": 0.1,
  • "smoothing": 0.1,
  • "offset": "string",
  • "idref": 0
}

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Get project at current {projectid}

path Parameters
jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "contact": "string",
  • "phone": "string",
  • "client": "string",
  • "notes": "string",
  • "units": "string",
  • "ignore-user-units": false,
  • "copies": 0,
  • "waste": 0.1,
  • "sheet-usage": 0.1,
  • "layout-count": 0,
  • "layouts": [
    ],
  • "artworks": [
    ]
}

Close the job with ID of {jobid}

path Parameters
jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Export cutting DXF

path Parameters
jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

path
string

Full path to store output file(s). When not set, the output file(s) will be stored on the server and download link(s) will be provided in the response.

version
string
Enum: "R13" "R2007"

DXF version to generate

units
string

Units to use in DXF

encoding
string
Enum: "US_ASCII" "IBM_874" "IBM_942" "GBK" "IBM_949" "IBM_950" "WINDOWS_1250" "WINDOWS_1251" "WINDOWS_1252" "WINDOWS_1253" "WINDOWS_1254" "WINDOWS_1255" "WINDOWS_1256" "WINDOWS_1257" "WINDOWS_1258" "UTF_8"

Character encoding to use. Note: For DXF versions 2007 and later UTF-8 encoding is always used and this setting is ignored.

include-barcode-marks
boolean

Whether or not to include barcode marks in cutting output

include-border-marks
boolean

Whether or not to include border marks in cutting output

include-camera-marks
boolean

Whether or not to include camera marks in cutting output

include-corner-marks
boolean

Whether or not to include corner marks in cutting output

include-grommet-marks
boolean

Whether or not to include grommet marks in cutting output

include-fill-marks
boolean

Whether or not to include fill marks in cutting output

include-waste-dividers
boolean

Whether or not to include waste divider marks in cutting output

include-fotoba-marks
boolean

Whether or not to include fotoba marks in cutting output

object (ToolEntity)

Tool used during post-press cutting, creasing, etc.

Array of objects (ToolDxfMappingEntity)

Tool type mappings to include in cutting output

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "version": "R13",
  • "units": "string",
  • "encoding": "US_ASCII",
  • "include-barcode-marks": true,
  • "include-border-marks": true,
  • "include-camera-marks": true,
  • "include-corner-marks": true,
  • "include-grommet-marks": true,
  • "include-fill-marks": true,
  • "include-waste-dividers": true,
  • "include-fotoba-marks": true,
  • "marks-tool-type": {
    },
  • "tool-mappings": [
    ]
}

Export Kongsberg JDF

path Parameters
jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

path
string

Full path to store output file(s). When not set, the output file(s) will be stored on the server and download link(s) will be provided in the response.

job-id
required
string

The Job ID name to use for this export

descriptive-name
string

The descriptive name for this export

include-preview
boolean

This value indicates whether to include a preview with the JDF file

barcode-layer
string

The barcode layer to use for this export

required
object (ExportCuttingPdfResource)

Export cutting PDF action resource

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "job-id": "string",
  • "descriptive-name": "string",
  • "include-preview": true,
  • "barcode-layer": "string",
  • "cutting-params": {
    }
}

Export cutting ZCC

path Parameters
jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

path
string

Full path to store output file(s). When not set, the output file(s) will be stored on the server and download link(s) will be provided in the response.

job-name
required
string

Job name to use in ZCC. Job name can include dynamic keywords like <project.filename> and <layout.random>.

cutting-mode
string
Enum: "Standard" "Quality" "Speed"

The cutting mode to use in Zund Cut Center

version
string
Enum: "V3" "V4"

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "job-name": "string",
  • "cutting-mode": "Standard",
  • "version": "V3"
}

Export JSON Job Report of the given job

path Parameters
jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

path
string

Full path to store output file(s). When not set, the output file(s) will be stored on the server and download link(s) will be provided in the response.

include-artwork-details
string
Enum: "All" "Placed" "None"

Whether to output the artwork details in the report.

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "include-artwork-details": "All"
}

[Requires Griffin+ Auto license] Export PDF Job Report of the given job

path Parameters
jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

path
string

Full path to store output file(s). When not set, the output file(s) will be stored on the server and download link(s) will be provided in the response.

include-artwork-details
string
Enum: "All" "Placed" "None"

Whether to output the artwork details in the report.

decimal-places
integer <int32>

The number of decimal places to display.

size
string
Enum: "A4" "Letter"

The size of page to export.

object (MarginsEntity)

Left, top, right and bottom scalar margins entity

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "include-artwork-details": "All",
  • "decimal-places": 0,
  • "size": "A4",
  • "margins": {
    }
}

Export cutting PDF

path Parameters
jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

path
string

Full path to store output file(s). When not set, the output file(s) will be stored on the server and download link(s) will be provided in the response.

layout-grouping
string
Enum: "SingleFile" "PerLayout" "PerSide"

Layout file grouping option controls whether layouts are exported as a single file or as separate files per layout or per layout side

include-barcode-marks
boolean

Whether or not to include barcode marks in cutting output

include-border-marks
boolean

Whether or not to include border marks in cutting output

include-camera-marks
boolean

Whether or not to include camera marks in cutting output

include-corner-marks
boolean

Whether or not to include corner marks in cutting output

include-grommet-marks
boolean

Whether or not to include grommet marks in cutting output

include-text-marks
boolean

Whether or not to include text marks in cutting output

include-fill-marks
boolean

Whether or not to include fill marks in cutting output

use-pdf-user-unit
boolean

use this option if you are working with layouts with dimensions over 200 inches (roughly 5 meters) and your cutting device supports the PDF 1.6 ‘UserUnit’ field to address size limitations in the PDF specification. Defaults to true when not specified.

include-waste-dividers
boolean

Whether or not to include waste divider marks in cutting output

include-fotoba-marks
boolean

Whether or not to include fotoba marks in cutting output

Array of objects (ToolPdfMappingEntity)

Tool type mappings to include in cutting output

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "layout-grouping": "SingleFile",
  • "include-barcode-marks": true,
  • "include-border-marks": true,
  • "include-camera-marks": true,
  • "include-corner-marks": true,
  • "include-grommet-marks": true,
  • "include-text-marks": true,
  • "include-fill-marks": true,
  • "use-pdf-user-unit": true,
  • "include-waste-dividers": true,
  • "include-fotoba-marks": true,
  • "tool-mappings": [
    ]
}

Export printing PDF

path Parameters
jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

path
string

Full path to store output file(s). When not set, the output file(s) will be stored on the server and download link(s) will be provided in the response.

layout-grouping
string
Enum: "SingleFile" "PerLayout" "PerSide"

Layout file grouping option controls whether layouts are exported as a single file or as separate files per layout or per layout side

page-per-copy
boolean

Whether to output repeated pages for multi-copy layouts. See 'allow-copies' nesting setting.

remove-artwork-tool-paths
boolean

If enabled, original tool paths in the artwork content are removed in the printing PDF. Currently only tool paths defined as spot colors can be removed.

use-pdf-user-unit
boolean

use this option if you are working with layouts with dimensions over 200 inches (roughly 5 meters) and your RIP supports the PDF 1.6 ‘UserUnit’ field to address size limitations in the PDF specification. Defaults to true when not specified.

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "layout-grouping": "SingleFile",
  • "page-per-copy": true,
  • "remove-artwork-tool-paths": true,
  • "use-pdf-user-unit": true
}

[Requires Griffin+ Auto license] Export Tiling Job Report of the given job

path Parameters
jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

path
string

Full path to store output file(s). When not set, the output file(s) will be stored on the server and download link(s) will be provided in the response.

size
string
Enum: "A4" "Letter"

The size of page to export.

object (MarginsEntity)

Left, top, right and bottom scalar margins entity

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "size": "A4",
  • "margins": {
    }
}

Export XML Job Report of the given job

path Parameters
jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

path
string

Full path to store output file(s). When not set, the output file(s) will be stored on the server and download link(s) will be provided in the response.

include-artwork-details
string
Enum: "All" "Placed" "None"

Whether to output the artwork details in the report.

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "include-artwork-details": "All"
}

Get layout in the job by index

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "id": "string",
  • "index": 0,
  • "double-sided": "Turn",
  • "width": "string",
  • "height": "string",
  • "copies": 0,
  • "placed": 0,
  • "unique": 0,
  • "waste": 0.1,
  • "sheet-usage": 0.1,
  • "substrate-name": "string",
  • "substrate-thickness": "string",
  • "tool-stats": {
    }
}

Edit layout properties

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

object (EditLayoutEntity)

Edit layout

Responses

Request samples

Content type
{
  • "idref": 0,
  • "layout": {
    }
}

Fit layout by index

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Delete layout in the job by index

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Get list of all layouts in the job

path Parameters
jobid
required
string

ID of the job

Responses

Start running Nesting tool to generate layouts

path Parameters
jobid
required
string

ID of the job

Request Body schema:
substrate-type
string
Enum: "Board" "Roll"

Type of substrate to nest artwork pieces onto. Defaults to Roll when not specified.

substrate-width
required
string

Width of substrate to nest artwork pieces onto

substrate-height
string

Height of substrate to nest artwork pieces onto for Board substrate type. This setting is ignored when substrate type is Roll but required when substrate type is Board.

substrate-flutes
string
Enum: "Long" "Short" "None"

Flutes direction of sheet for boards. This setting is ignored when substrate type is Roll where flutes are assumed to run in the direction of the roll. For Board substrate, this setting defaults to None when not specified.

substrate-name
string

Optional name of substrate used in reporting and Zund Cut Center (ZCC) cutting output

substrate-thickness
string

Substrate thickness. Thickness is included in reporting and Zund Cut Center (ZCC) cutting output to automatically match the substrate with the corresponding material in Zund Cut Center.

min-roll-cutoff
string

Minimum roll cutoff height when substrate type is Roll

max-roll-cutoff
string

Maximum roll cutoff height when substrate type is Roll

object (MarginsEntity)

Left, top, right and bottom scalar margins entity

strategy
string
Enum: "FreeNesting" "GridNesting" "Guillotine"

Type of nesting to perform

first-cut
string
Enum: "Horizontal" "Vertical" "Either"

First cut option when nesting type is Guillotine

rotation
string
Enum: "Any" "Orthogonal" "None"

Type of rotation to allow during nesting

vertical-placement
string
Enum: "Bottom" "Center" "Top"

Vertical position on the layout to align nested artwork pieces

horizontal-placement
string
Enum: "Left" "Center" "Right"

Horizontal position on the layout to align nested artwork pieces

double-sided
string
Enum: "Turn" "Tumble"

Workstyle when handling double-sided work

separate-double-sided
boolean

Whether to separate single- and double-sided artwork into separate layouts or allow them to be combined within the same layout. Defaults to false (allow mixing) when not specified.

allow-copies
boolean

Whether to allow multiple layout copies. When not specified, mulitple layout copies are assumed to be allowed by the nesting tool.

Array of objects (BarcodeMarkEntity)

Barcodes to apply to all layouts

Array of objects (BorderMarkEntity)

Border to apply to all layouts

Array of objects (CameraMarkEntity)

Camera marks to apply to all layouts

Array of objects (Corner Mark)

Corner to apply to all layouts

Array of objects (ShapeMarkEntity)

Shape marks to apply to all layouts

Array of objects (TextMarkEntity)

Text marks to apply to all layouts

Array of objects (WasteDividerEntity)

Waste dividers to apply to all layouts

Array of objects (FotobaMarkEntity)

Fotoba marks to apply to all layouts

Responses

Request samples

Content type
{
  • "substrate-type": "Board",
  • "substrate-width": "string",
  • "substrate-height": "string",
  • "substrate-flutes": "Long",
  • "substrate-name": "string",
  • "substrate-thickness": "string",
  • "min-roll-cutoff": "string",
  • "max-roll-cutoff": "string",
  • "margins": {
    },
  • "strategy": "FreeNesting",
  • "first-cut": "Horizontal",
  • "rotation": "Any",
  • "vertical-placement": "Bottom",
  • "horizontal-placement": "Left",
  • "double-sided": "Turn",
  • "separate-double-sided": true,
  • "allow-copies": true,
  • "barcode-marks": [
    ],
  • "border-marks": [
    ],
  • "camera-marks": [
    ],
  • "corner-marks": [
    ],
  • "shape-marks": [
    ],
  • "text-marks": [
    ],
  • "waste-dividers": [
    ],
  • "fotoba-marks": [
    ]
}

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Get current nesting tool status

path Parameters
jobid
required
string

ID of the job

query Parameters
layouts
boolean
Default: false

Include individual layout stats

thumbs
boolean
Default: false

Include individual thumbnail images in layout stats or not

Responses

Response samples

Content type
{
  • "state": "NotStarted",
  • "running-time": 0.1,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "progress": 0.1,
  • "waste": 0.1,
  • "layout-count": 0,
  • "layouts": [
    ]
}

Stop nesting tool if it is currently running

path Parameters
jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Get output project file by ID

path Parameters
fileid
required
string

ID of output project file to get

jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "id": "string",
  • "action": "string",
  • "time": "string",
  • "files": [
    ]
}

Delete output project files from this project with specific file ID

path Parameters
fileid
required
string

ID of uploaded project file to get

jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Download specific output file content

path Parameters
fileid
required
string

ID of output project file to get

filepath
required
string.*

Relative path of specific file contents to download

jobid
required
string

ID of the job

Responses

Get all output files currently saved to this project

path Parameters
jobid
required
string

ID of the job

Responses

Response samples

Content type
[
  • {
    }
]

Save project

path Parameters
jobid
required
string

ID of the job

Request Body schema:
idref
integer <int32>

ID of action resource is being applied to (Hot Folders only)

path
string

Full path to store output file(s). When not set, the output file(s) will be stored on the server and download link(s) will be provided in the response.

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string"
}

Get uploaded project file by ID

path Parameters
fileid
required
string

ID of uploaded project file to get

jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "id": "string",
  • "action": "string",
  • "time": "string",
  • "files": [
    ]
}

Delete uploaded project file from this project

path Parameters
fileid
required
string

ID of uploaded project file to get

jobid
required
string

ID of the job

Responses

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Download specific uploaded file content

path Parameters
fileid
required
string

ID of uploaded project file to get

filepath
required
string.*

Relative path of specific file contents to download

jobid
required
string

ID of the job

Responses

Get all files currently uploaded to this project

path Parameters
jobid
required
string

ID of the job

Responses

Response samples

Content type
[
  • {
    }
]

Upload new file to project

The URI returned in the response entity can be used to download the file content directly or referred to when adding products.

path Parameters
jobid
required
string

ID of the job

Request Body schema: multipart/form-data
object (FormDataContentDisposition)

Responses

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Open existing project file

The file needs to be updated via form data. The filename content disposition header excluding filename extension is used to define the project ID if present, otherwise the existing project ID in the project is used.

Request Body schema: multipart/form-data
object (FormDataContentDisposition)

Responses

Response samples

Content type
{
  • "success": true,
  • "status-code": 0,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "resources": [
    ]
}

Libraries API

Library management

Get list of all available font families

Responses

Response samples

Content type
[
  • {
    }
]