API docs by Redocly

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

Jobs API

Job automation (will be deprecated and replaced by Projects API in the future)

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)

template-path
string

Job template path for creating a new job from a template file or reporting which template was used to create a given job

Array of objects (propertyObject)

Custom properties

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,
  • "template-path": "string",
  • "properties": [
    ]
}

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": [
    ]
}

Get project at current {projectid}

path Parameters
jobid
required
string

ID of the project

query Parameters
product-version
string
Default: "V1"
Enum: "V1" "V2"

Product model version

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "contact": "string",
  • "phone": "string",
  • "client": "string",
  • "notes": "string",
  • "units": "string",
  • "ignore-user-units": false,
  • "template-path": "string",
  • "run-length": 0,
  • "press-minutes": 0.1,
  • "plate-cost": 0.1,
  • "stock-cost": 0.1,
  • "press-cost": 0.1,
  • "die-cost": 0.1,
  • "total-cost": 0.1,
  • "waste": 0.1,
  • "sheet-usage": 0.1,
  • "underrun": 0.1,
  • "overrun": 0.1,
  • "layout-count": 0,
  • "facility": {
    },
  • "layouts": [
    ],
  • "products": [
    ],
  • "products2": [
    ],
  • "rolls": [
    ],
  • "messages": [
    ],
  • "properties": [
    ]
}

Close the project with ID of {projectid}

path Parameters
jobid
required
string

ID of the project

Responses

Response samples

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

Edit project

path Parameters
jobid
required
string

ID of the 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

idref
integer <int32>

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

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "contact": "string",
  • "phone": "string",
  • "client": "string",
  • "notes": "string",
  • "units": "string",
  • "idref": 0,
  • "properties": [
    ]
}

Response samples

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

Export layout cover sheet(s) of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export CSV Report of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export CFF2 Die Layout of current project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export DXF Die Layout of current project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

(Beta) Export MFG Die Layout of current project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export PDF Die Layout of current project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export Zund Cut Center Layout of current project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export HP JDF of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export Layout JDF of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export JDF Cutting Data of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export Kongsberg JDF of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export JSON Project Report of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export Layout PDF of current project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export PDF Project Report of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export Vector Separation of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export Tiling report of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Export XML Project Report of the given project

path Parameters
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Import die template

path Parameters
jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

path
required
string

Full path of file name

preset
string

Name of die template preset to use

Responses

Request samples

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

Response samples

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

Apply result from most recent Impose run

path Parameters
layoutindex
required
integer <int32>

Index of layout

resultid
required
integer <int32>

Id of result to apply

jobid
required
string

ID of the project

Responses

Response samples

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

Run Impose tool to generate layouts

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

products
Array of strings

Names of products to include. When not specified all products in the job are included

profiles
Array of strings

Optional profiles to use when running Imposition AI. The default profile is used when this field is not set

Array of objects (ImpositionAiProfileEntity)

Optional inline fully defined profiles to use when running Imposition AI.

stop-minutes
integer <int32>

Number of minutes to allow this action to run before stopping. Default is 60 minutes when not specified.

templates
required
Array of strings

Names of templates to use during Impose

Responses

Request samples

Content type
{
  • "idref": 0,
  • "products": [
    ],
  • "profiles": [
    ],
  • "profiles-inline": [
    ],
  • "stop-minutes": 0,
  • "templates": [
    ]
}

Response samples

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

A single Impose result by ID

path Parameters
layoutindex
required
integer <int32>

Index of layout

resultid
required
integer <int32>

ID of result to retrieve

jobid
required
string

ID of the project

query Parameters
thumb
boolean
Default: false

Include thumbnail image or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail image

Responses

Response samples

Content type
{
  • "id": 0,
  • "timestamp": 0.1,
  • "pending-estimations": true,
  • "layout-type": "string",
  • "sheet": "string",
  • "stock": "string",
  • "grade": "string",
  • "things": [
    ],
  • "run-length": 0,
  • "press-minutes": 0.1,
  • "cutting-time": 0.1,
  • "total-cost": 0.1,
  • "plate-cost": 0.1,
  • "stock-cost": 0.1,
  • "press-cost": 0.1,
  • "cutting-cost": 0.1,
  • "waste": 0.1,
  • "sheet-usage": 0.1,
  • "max-overrun": 0.1,
  • "total-overruns": 0,
  • "placed": 0,
  • "items": {
    },
  • "cut-complexity": 0,
  • "templates": [
    ],
  • "thumbnail": {
    },
  • "press": "string"
}

A list of most recent Impose results

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

query Parameters
thumb
boolean
Default: false

Include thumbnail images or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail image

Responses

Response samples

Content type
[
  • {
    }
]

Get list of all layouts in the project

path Parameters
jobid
required
string

ID of the project

query Parameters
front-thumb
boolean
Default: false

Whether to include thumbnail images of the front surfaces of the layouts

back-thumb
boolean
Default: false

Whether to include thumbnail images of the back surfaces of the layouts

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail images

Responses

Response samples

Content type
[
  • {
    }
]

Create a new layout

path Parameters
jobid
required
string

ID of the project

Responses

Response samples

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

Get back layout surface

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

query Parameters
thumb
boolean
Default: false

Whether to include thumbnail image of surface

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail image

Responses

Response samples

Content type
{
  • "side": "Front",
  • "press": {
    },
  • "stock": {
    },
  • "grade": {
    },
  • "sheet": {
    },
  • "plate": {
    },
  • "items": {
    },
  • "inks": [
    ],
  • "thumbnail": {
    },
  • "messages": [
    ],
  • "properties": [
    ]
}

Edit surface

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "idref": 0,
  • "properties": [
    ]
}

Response samples

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

Get project layout by index

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

query Parameters
front-thumb
boolean
Default: false

Whether to include thumbnail image of the front surface of this layout

back-thumb
boolean
Default: false

Whether to include thumbnail image of the back surface of this layout

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail image(s)

Responses

Response samples

Content type
{
  • "id": "string",
  • "index": 0,
  • "name": "string",
  • "workstyle": "FlatWork",
  • "trails": [
    ],
  • "run-length": 0,
  • "press-minutes": 0.1,
  • "plates": 0,
  • "plate-cost": 0.1,
  • "stock-cost": 0.1,
  • "press-cost": 0.1,
  • "die-cost": 0.1,
  • "total-cost": 0.1,
  • "waste": 0.1,
  • "sheet-usage": 0.1,
  • "underrun": 0.1,
  • "overrun": 0.1,
  • "placed": 0,
  • "product-count": 0,
  • "random": "string",
  • "templates": [
    ],
  • "tool-stats": {
    },
  • "priority-stats": [
    ],
  • "surfaces": [
    ],
  • "properties": [
    ],
  • "front": {
    },
  • "back": {
    }
}

Edit layout properties

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

name
string

Layout name, when specified edits current layout name

workstyle
string
Enum: "FlatWork" "Sheetwise" "Perfecting" "WorkAndTurn" "WorkAndTumble"

Workstyle of layout, when specified changes workstyle

run-length
integer <int32>

Layout run length, when specified overrides current layout run length

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "idref": 0,
  • "name": "string",
  • "workstyle": "FlatWork",
  • "run-length": 0,
  • "properties": [
    ]
}

Response samples

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

Delete layout from the project by index

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Responses

Response samples

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

Get front layout surface

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

query Parameters
thumb
boolean
Default: false

Whether to include thumbnail image of surface

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail image

Responses

Response samples

Content type
{
  • "side": "Front",
  • "press": {
    },
  • "stock": {
    },
  • "grade": {
    },
  • "sheet": {
    },
  • "plate": {
    },
  • "items": {
    },
  • "inks": [
    ],
  • "thumbnail": {
    },
  • "messages": [
    ],
  • "properties": [
    ]
}

Edit surface

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "idref": 0,
  • "properties": [
    ]
}

Response samples

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

Place component of product

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

product-name
required
string

Name of product to place and repeat

component-index
required
integer <int32>

index of component

part-index
required
integer <int32>

index of part

x
required
string

Optional X position to place component in sheet

y
required
string

Optional Y position to place component in sheet.

rotation
required
number <double>

Rotation to apply to product

Responses

Request samples

Content type
{
  • "idref": 0,
  • "product-name": "string",
  • "component-index": 0,
  • "part-index": 0,
  • "x": "string",
  • "y": "string",
  • "rotation": 0.1
}

Response samples

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

Place die template

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

name
required
string

Name of die template to place in layout

x
string

Optional X position to place layout in sheet

y
string

Optional Y position to place layout in sheet

Responses

Request samples

Content type
{
  • "idref": 0,
  • "name": "string",
  • "x": "string",
  • "y": "string"
}

Response samples

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

Get layout plate

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "width": "string",
  • "height": "string",
  • "punch-height": "string",
  • "h-distortion": 0.1,
  • "v-distortion": 0.1,
  • "price": 0.1
}

Set layout plate

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

name
string

Name of library item to use

Responses

Request samples

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

Response samples

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

Get layout press Deprecated

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "manufacturer": "string",
  • "speed": 0.1,
  • "speed-units": "SheetsPerMinute",
  • "cost-per-hour": 0.1,
  • "make-ready-time": 0.1,
  • "number-of-colors": 0,
  • "min-run-length": 0,
  • "back-single-pass": true,
  • "workstyle": "FlatWork",
  • "back-number-of-colors": 0,
  • "back-speed-reduction": 0.1,
  • "multi-pass": true,
  • "min-sheet-width": "string",
  • "max-sheet-width": "string",
  • "min-sheet-height": "string",
  • "max-sheet-height": "string",
  • "min-stock-thickness": "string",
  • "max-stock-thickness": "string",
  • "min-stock-weight": 0.1,
  • "max-stock-weight": 0.1,
  • "weight-units": "GSM",
  • "weight-type": "Text",
  • "sheet-handling": "None",
  • "image-margins": {
    },
  • "content-margins": {
    },
  • "gripper": "string",
  • "default-plate": "string"
}

Set layout press Deprecated

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

name
string

Name of library item to use

Responses

Request samples

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

Response samples

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

Get layout sheet

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "stock-id": "string",
  • "grade-id": "string",
  • "dimension1": "string",
  • "dimension2": "string",
  • "cost": 0.1,
  • "cost-units": "FromGrade",
  • "grain": "Long"
}

Resize layout sheet

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

width
string

New width of current layout sheet

height
string

New height of current layout sheet

Responses

Request samples

Content type
{
  • "idref": 0,
  • "width": "string",
  • "height": "string"
}

Response samples

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

Set layout sheet

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

stock
string

Name of sheet stock

grade
string

Name of sheet grade

name
string

Name of sheet within stock to use

Responses

Request samples

Content type
{
  • "idref": 0,
  • "stock": "string",
  • "grade": "string",
  • "name": "string"
}

Response samples

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

Generate step and repeat group

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

product-name
required
string

Name of product to step and repeat

x
string

Optional X position to place repeat group in sheet. This value is ignored if an auto-fill option is defined in settings in horizontal direction.

y
string

Optional Y position to place repeat group in sheet. This value is ignored if an auto-fill option is defined in settings in vertical direction.

required
object (StepRepeatEntity)

Step and Repeat parameters

Responses

Request samples

Content type
{
  • "idref": 0,
  • "product-name": "string",
  • "x": "string",
  • "y": "string",
  • "settings": {
    }
}

Response samples

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

Apply result from most recent Optimize run

path Parameters
layoutindex
required
integer <int32>

Index of layout

resultid
required
integer <int32>

Id of result to apply

jobid
required
string

ID of the project

Responses

Response samples

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

Run Optimize tool to generate layouts

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

products
Array of strings

Names of products to include. When not specified all products in the job are included

profiles
Array of strings

Optional profiles to use when running Imposition AI. The default profile is used when this field is not set

Array of objects (ImpositionAiProfileEntity)

Optional inline fully defined profiles to use when running Imposition AI.

stop-minutes
integer <int32>

Number of minutes to allow this action to run before stopping. Default is 60 minutes when not specified.

things
Array of strings

Names of things to use during Optimize

Array of objects (SheetRefEntity)

Sheets to use during Optimize

Array of objects (SheetRefEntity)

Rolls to use during Optimize

templates
Array of strings

Names of templates to use during Optimize

presses
Array of strings

(Deprecated) Names of presses to use during Optimize

Responses

Request samples

Content type
{
  • "idref": 0,
  • "products": [
    ],
  • "profiles": [
    ],
  • "profiles-inline": [
    ],
  • "stop-minutes": 0,
  • "things": [
    ],
  • "sheets": [
    ],
  • "rolls": [
    ],
  • "templates": [
    ],
  • "presses": [
    ]
}

Response samples

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

A single Optimize result by ID

path Parameters
layoutindex
required
integer <int32>

Index of layout

resultid
required
integer <int32>

ID of result to retrieve

jobid
required
string

ID of the project

query Parameters
thumb
boolean
Default: false

Include thumbnail image or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail image

Responses

Response samples

Content type
{
  • "id": 0,
  • "timestamp": 0.1,
  • "pending-estimations": true,
  • "layout-type": "string",
  • "sheet": "string",
  • "stock": "string",
  • "grade": "string",
  • "things": [
    ],
  • "run-length": 0,
  • "press-minutes": 0.1,
  • "cutting-time": 0.1,
  • "total-cost": 0.1,
  • "plate-cost": 0.1,
  • "stock-cost": 0.1,
  • "press-cost": 0.1,
  • "cutting-cost": 0.1,
  • "waste": 0.1,
  • "sheet-usage": 0.1,
  • "max-overrun": 0.1,
  • "total-overruns": 0,
  • "placed": 0,
  • "items": {
    },
  • "cut-complexity": 0,
  • "templates": [
    ],
  • "thumbnail": {
    },
  • "press": "string"
}

A list of most recent Optimize results

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

query Parameters
thumb
boolean
Default: false

Include thumbnail images or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail image

Responses

Response samples

Content type
[
  • {
    }
]

Get output project file by ID

path Parameters
fileid
required
string

ID of output project file to get

jobid
required
string

ID of the project

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 project

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 project

Responses

Get all output files currently saved to this project

path Parameters
jobid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Apply result from most recent plan run

path Parameters
resultid
required
integer <int32>

Id of result to apply

start
required
integer <int32>

First layout to apply from plan starting from 1

end
required
integer <int32>

Last layout to apply from plan

jobid
required
string

ID of the project

Responses

Response samples

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

Apply result from most recent plan run

path Parameters
resultid
required
integer <int32>

Id of result to apply

jobid
required
string

ID of the project

Responses

Response samples

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

Run Plan tool to generate project plans

path Parameters
jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

products
Array of strings

Names of products to include. When not specified all products in the job are included

profiles
Array of strings

Optional profiles to use when running Imposition AI. The default profile is used when this field is not set

Array of objects (ImpositionAiProfileEntity)

Optional inline fully defined profiles to use when running Imposition AI.

stop-minutes
integer <int32>

Number of minutes to allow this action to run before stopping. Default is 60 minutes when not specified.

things
Array of strings

Names of things to use during Plan

Array of objects (SheetRefEntity)

Sheets to use during Plan

Array of objects (SheetRefEntity)

Rolls to use during Plan

templates
Array of strings

Names of templates to use during Plan

apply-result
boolean

Apply lowest cost Plan result automatically. If not specified, no results are applied.

presses
Array of strings

(Deprecated) Names of presses to use during Plan

Responses

Request samples

Content type
{
  • "idref": 0,
  • "products": [
    ],
  • "profiles": [
    ],
  • "profiles-inline": [
    ],
  • "stop-minutes": 0,
  • "things": [
    ],
  • "sheets": [
    ],
  • "rolls": [
    ],
  • "templates": [
    ],
  • "apply-result": true,
  • "presses": [
    ]
}

Response samples

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

A single plan result by ID

path Parameters
resultid
required
integer <int32>

ID of result to retrieve

jobid
required
string

ID of the project

query Parameters
layouts
boolean
Default: false

Include individual layout results

thumb
boolean
Default: false

Include thumbnail images in layout results or not

plan-thumb
boolean
Default: false

Include composite thumbnail image of layouts in plan result or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in layout result thumbnail images

Responses

Response samples

Content type
{
  • "id": 0,
  • "timestamp": 0.1,
  • "pending-estimations": true,
  • "press-minutes": 0.1,
  • "cutting-time": 0.1,
  • "run-length": 0,
  • "roll-length": "string",
  • "total-cost": 0.1,
  • "plate-cost": 0.1,
  • "stock-cost": 0.1,
  • "press-cost": 0.1,
  • "cutting-cost": 0.1,
  • "waste": 0.1,
  • "sheet-usage": 0.1,
  • "total-underruns": 0,
  • "total-overruns": 0,
  • "layout-count": 0,
  • "layouts": [
    ],
  • "thumbnail": {
    }
}

A list of most recent Plan results

path Parameters
jobid
required
string

ID of the project

query Parameters
limit
integer <int32>
Default: 0

Optional limit to number of results returned. 0 or not-specified signifies return all results.

start
integer <int32>
Default: 0

Optional 1-based start index of results after sorting

sorting
string
Default: "Cost"
Enum: "Cost" "Waste" "Time" "Layouts"

Optional sorting to control order of results. By default results are sorted by lowest cost first.

layouts
boolean
Default: false

Include individual layout results

thumb
boolean
Default: false

Include individual thumbnail images in layout results or not

plan-thumb
boolean
Default: false

Include composite thumbnail image of layouts in plan result or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in layout result thumbnail images. Note: Artwork rendering can be compute intensive and result in slow response times, especially when there are many results being returned.

Responses

Response samples

Content type
[
  • {
    }
]

Start running Plan tool asynchronously to generate project plans

path Parameters
jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

products
Array of strings

Names of products to include. When not specified all products in the job are included

profiles
Array of strings

Optional profiles to use when running Imposition AI. The default profile is used when this field is not set

Array of objects (ImpositionAiProfileEntity)

Optional inline fully defined profiles to use when running Imposition AI.

stop-minutes
integer <int32>

Number of minutes to allow this action to run before stopping. Default is 60 minutes when not specified.

things
Array of strings

Names of things to use during Plan

Array of objects (SheetRefEntity)

Sheets to use during Plan

Array of objects (SheetRefEntity)

Rolls to use during Plan

templates
Array of strings

Names of templates to use during Plan

apply-result
boolean

Apply lowest cost Plan result automatically. If not specified, no results are applied.

presses
Array of strings

(Deprecated) Names of presses to use during Plan

Responses

Request samples

Content type
{
  • "idref": 0,
  • "products": [
    ],
  • "profiles": [
    ],
  • "profiles-inline": [
    ],
  • "stop-minutes": 0,
  • "things": [
    ],
  • "sheets": [
    ],
  • "rolls": [
    ],
  • "templates": [
    ],
  • "apply-result": true,
  • "presses": [
    ]
}

Response samples

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

Get current plan tool running status

path Parameters
jobid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "state": "NotStarted",
  • "running-time": 0.1,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "results": 0,
  • "lowest-cost": 0.1,
  • "lowest-waste": 0.1,
  • "lowest-layouts": 0
}

Stop plan tool if it is currently running

path Parameters
jobid
required
string

ID of the project

Responses

Response samples

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

Apply result from most recent Populate run

path Parameters
layoutindex
required
integer <int32>

Index of layout

resultid
required
integer <int32>

Id of result to apply

jobid
required
string

ID of the project

Responses

Response samples

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

Run Populate tool to generate layouts

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

products
Array of strings

Names of products to include. When not specified all products in the job are included

profiles
Array of strings

Optional profiles to use when running Imposition AI. The default profile is used when this field is not set

Array of objects (ImpositionAiProfileEntity)

Optional inline fully defined profiles to use when running Imposition AI.

stop-minutes
integer <int32>

Number of minutes to allow this action to run before stopping. Default is 60 minutes when not specified.

Responses

Request samples

Content type
{
  • "idref": 0,
  • "products": [
    ],
  • "profiles": [
    ],
  • "profiles-inline": [
    ],
  • "stop-minutes": 0
}

Response samples

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

A single Populate result by ID

path Parameters
layoutindex
required
integer <int32>

Index of layout

resultid
required
integer <int32>

ID of result to retrieve

jobid
required
string

ID of the project

query Parameters
thumb
boolean
Default: false

Include thumbnail image or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail image

Responses

Response samples

Content type
{
  • "id": 0,
  • "timestamp": 0.1,
  • "pending-estimations": true,
  • "layout-type": "string",
  • "sheet": "string",
  • "stock": "string",
  • "grade": "string",
  • "things": [
    ],
  • "run-length": 0,
  • "press-minutes": 0.1,
  • "cutting-time": 0.1,
  • "total-cost": 0.1,
  • "plate-cost": 0.1,
  • "stock-cost": 0.1,
  • "press-cost": 0.1,
  • "cutting-cost": 0.1,
  • "waste": 0.1,
  • "sheet-usage": 0.1,
  • "max-overrun": 0.1,
  • "total-overruns": 0,
  • "placed": 0,
  • "items": {
    },
  • "cut-complexity": 0,
  • "templates": [
    ],
  • "thumbnail": {
    },
  • "press": "string"
}

A list of most recent Populate results

path Parameters
layoutindex
required
integer <int32>

Index of layout

jobid
required
string

ID of the project

query Parameters
thumb
boolean
Default: false

Include thumbnail images or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail image

Responses

Response samples

Content type
[
  • {
    }
]

Get all products of the current project

path Parameters
jobid
required
string

ID of the project

query Parameters
thumb
boolean
Default: false

Whether to include thumbnail image of products

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail images

Responses

Response samples

Content type
[
  • {
    }
]

Create new product

path Parameters
jobid
required
string

ID of the project

Request Body schema:
name
string

Unique name of the product

type
string
Enum: "Flat" "Tiled" "Folded" "Bound"

Optional type of product: flat, tiled, bound, folded

color
string

Product color specified as RGB or ARGB hex value with optional leading hex ('#') symbol

ordered
integer <int32>

Number of product ordered in the job

stock
string

Stock of product

grade
string

Grade of product stock

Array of objects (PageColorEntity)

Page colors for front side of flat products or all pages of bound and folded products

Array of objects (PageColorEntity)

Page back colors for back side of flat products

color-source
string
Enum: "Artwork" "Specified"

Setting to specify how toset up colors for each page

color-analysis
string
Enum: "Fast" "Raster"

Mode to use when analyzing artwork colors when color source is set to Artwork

color-detection
string
Enum: "Cut" "Bleed"

Color detection region to use when determining which colors are present in artwork during raster color analysis

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

Grain direction of product

width
string

Width of product when creating a custom size product or the desired scaled width or scale percentage when creating the product die from a die design or artwork

height
string

Height of product when creating a custom size product or the desired scaled height or scale percentage when creating the product die from a die design or artwork

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

Rotation type to allow in product, defaults to Product settings defaults unless allowed-rotations is defined in which case 'Custom' rotation type is assumed

allowed-rotations
string

Allowed rotations of product when rotation type is 'Custom'

templates
Array of strings

List of templates this product can be used with

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.

artwork
string

Path to artwork file when creating product from artwork or snapping artwork into die

page
integer <int32>

Page of artwork to use, defaults to page 1 when not defined

back-artwork
string

Path to artwork file for back side of product when creating product from artwork or snapping artwork into die

back-page
integer <int32>

Page of artwork to use for back side of product

dieshape-source
string
Enum: "CAD" "ArtworkPaths" "ArtworkTrimbox" "CustomSize" "DieDesignLibrary" "PdfPlus"

Source type to use when creating dieshape for product. If not defined, cad-file die takes priority, followed by dieshape library name, then height and width fields, and finally artwork Trimbox or artwork path line mappings depending on whether product settings automatically take dieshape from line mappings

die-design
string

Path to die in Die Design Library when using library die design for 1-up die of the product

autosnap-ink
string

PDF ink color to use for autosnapping artwork into 1-up die on the front side of the product

back-autosnap-ink
string

PDF ink color to use for autosnapping artwork into 1-up die on the back side of the product

autosnap-layer
string

PDF layer to use for autosnapping artwork into 1-up die on the front side of the product

back-autosnap-layer
string

PDF layer to use for autosnapping artwork into 1-up die on the back side of the product

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 product for each closed path shape detected in the artwork.

page-handling
string
Enum: "OnePerFile" "OnePerPage" "OnePerTwoPages"

Multi-page artwork handling options for flat and tiled products

front-to-back
string
Enum: "None" "Copy" "Mirror"

Action to perform to copy or mirror artwork on the front side of the flat product to the back side

cad-file
string

Path of CAD file to use when defining product based on 1-up design in a CAD file

cad-design
string

Design name of 1-up CAD design in the CAD file, defaults to first 1-up in the CAD file when not defined

group
string

Optional product group used in Imposition AI

priority
integer <int32>

Optional priority of product starting from 1 as highest priority

due-date
string

Product due date

bleed-type
string
Enum: "Margins" "Contour" "CAD" "None"

Product bleed type = [Margins, Contour, Cad, or None]

bleed-margin
string

Scalar offset from die design to generate bleed

object (MarginsEntity)

Left, top, right and bottom scalar margins entity

page-bleed
string

Bleed margins of individual pages in bound and folded products

spacing-type
string
Enum: "Margins" "Uniform" "Bleed" "Tool"

Product spacing type = [Margins, Uniform, or Bleed]

spacing-margin
string

Single scalar spacing offset when spacing type is Uniform

object (MarginsEntity)

Left, top, right and bottom scalar margins entity

object (MarginsEntity)

Left, top, right and bottom scalar margins entity

min-overruns
string

Minimum overrun percentage allowed for the product

max-overruns
string

Maximum overrun percentage allowed for the product

description
string

Optional product description

notes
string

Optional notes to associate with product

Array of objects (ProcessSettingEntity)

List of process settings to use to control process-specific behavior

marks
Array of strings

Optional product marks to apply to the front side of the product

back-marks
Array of strings

Optional product marks to apply to the back side of the product

folding-patterns
Array of strings

Optional folding bound work

binding-method
string
Enum: "PerfectBound" "SaddleStitch" "None"

Optional binding method for bound work

assembly-mode
string
Enum: "Manual" "LargestFirst"

Optional assembly mode for bound work controlling how given folding patterns are ordered

binding-edge
string
Enum: "Top" "Bottom" "Right" "Left"

Page binding edge for bound work

jog-edge
string
Enum: "Top" "Bottom" "Right" "Left"

Jog edge for bound work. When set, this edge must be perpendicular to the binding edge. Setting jog to Bottom for left- or right-bound work results in 'Foot to Foot' page orientation.

reading-order
string
Enum: "Normal" "Calendar"

Reading order of pages in bound work

pages
integer <int32>

Total number of pages field for bound and folded work

pages-per-section
integer <int32>

Number of pages per section for multi-section bound work

self-cover
boolean

Whether bound part includes cover or not

object (TrimEntity)

Trim margin settings for bound part signatures

object (NUpEntity)

N-up settings for bound part signatures

object (CreepEntity)

Creep settings

bundle-size
integer <int32>

Bundle size needed for product. When set, Imposition AI tools will ensure layouts including this product will have run length multiples of this bundle size

max-bundle-splits
integer <int32>

Max Bundle Splits allowed when bundle size is set. When set, this property controls whether a given full bundle can to be broken into smaller bundle sizes for optimization reasons with default value of 0 signifying no splitting allowed

Array of objects (PropertyEntity)

Optional custom properties to apply to the product

object (tiling)

Tiling preset defining how tiling is performed

front-inks
Array of strings

(Deprecated) Printing inks on front side of product

back-inks
Array of strings

(Deprecated) Printing inks on back side of product

cut-ink
string

(Deprecated) Spot ink color used to define cut lines in the artwork

crease-ink
string

(Deprecated) Spot ink color used to define crease lines in the artwork

bleed-ink
string

(Deprecated) Spot ink color used to define bleed lines in the artwork

cut-layer
string

(Deprecated) PDF layer name used to define cut lines in the artwork

crease-layer
string

(Deprecated) PDF layer name used to define crease lines in the artwork

bleed-layer
string

(Deprecated) PDF layer name used to define bleed lines in the artwork

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "Flat",
  • "color": "string",
  • "ordered": 0,
  • "stock": "string",
  • "grade": "string",
  • "colors": [
    ],
  • "back-colors": [
    ],
  • "color-source": "Artwork",
  • "color-analysis": "Fast",
  • "color-detection": "Cut",
  • "grain": "Horizontal",
  • "width": "string",
  • "height": "string",
  • "rotation": "Any",
  • "allowed-rotations": "string",
  • "templates": [
    ],
  • "scale-proportionally": true,
  • "artwork": "string",
  • "page": 0,
  • "back-artwork": "string",
  • "back-page": 0,
  • "dieshape-source": "CAD",
  • "die-design": "string",
  • "autosnap-ink": "string",
  • "back-autosnap-ink": "string",
  • "autosnap-layer": "string",
  • "back-autosnap-layer": "string",
  • "shape-handling": "Largest",
  • "page-handling": "OnePerFile",
  • "front-to-back": "None",
  • "cad-file": "string",
  • "cad-design": "string",
  • "group": "string",
  • "priority": 0,
  • "due-date": "string",
  • "bleed-type": "Margins",
  • "bleed-margin": "string",
  • "bleed-margins": {
    },
  • "page-bleed": "string",
  • "spacing-type": "Margins",
  • "spacing-margin": "string",
  • "spacing-margins": {
    },
  • "offcut-margins": {
    },
  • "min-overruns": "string",
  • "max-overruns": "string",
  • "description": "string",
  • "notes": "string",
  • "process-settings": [
    ],
  • "marks": [
    ],
  • "back-marks": [
    ],
  • "folding-patterns": [
    ],
  • "binding-method": "PerfectBound",
  • "assembly-mode": "Manual",
  • "binding-edge": "Top",
  • "jog-edge": "Top",
  • "reading-order": "Normal",
  • "pages": 0,
  • "pages-per-section": 0,
  • "self-cover": true,
  • "trim": {
    },
  • "n-up": {
    },
  • "creep": {
    },
  • "bundle-size": 0,
  • "max-bundle-splits": 0,
  • "properties": [
    ],
  • "tiling": {
    },
  • "front-inks": [
    ],
  • "back-inks": [
    ],
  • "cut-ink": "string",
  • "crease-ink": "string",
  • "bleed-ink": "string",
  • "cut-layer": "string",
  • "crease-layer": "string",
  • "bleed-layer": "string"
}

Response samples

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

Import products from CSV file

path Parameters
jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

path
required
string

Full path of file name

preset
string

Name of CSV import preset to use

base-folder
string

Optional base folder to use for relative paths

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "preset": "string",
  • "base-folder": "string"
}

Response samples

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

Apply image tracing to the product

path Parameters
productname
required
string
jobid
required
string

ID of the project

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>

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": [
    ]
}

Apply a smart product mark to this product

path Parameters
productname
required
string
jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

name
string

Name of library item to use

side
string
Enum: "Front" "Back"

Which side to apply to mark to

Responses

Request samples

Content type
{
  • "idref": 0,
  • "name": "string",
  • "side": "Front"
}

Response samples

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

Get product with name of {productname}

path Parameters
productname
required
string
jobid
required
string

ID of the project

query Parameters
thumb
boolean
Default: false

Whether to include thumbnail image of product

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

render-mode
string
Default: "Colors"
Enum: "Artwork" "Colors" "Dielines"

Render mode to use in thumbnail image

Responses

Response samples

Content type
{
  • "index": 0,
  • "name": "string",
  • "color": "string",
  • "ordered": 0,
  • "description": "string",
  • "notes": "string",
  • "die-name": "string",
  • "die-source": "string",
  • "die-path": "string",
  • "stock": "string",
  • "grade": "string",
  • "grain": "Horizontal",
  • "width": "string",
  • "height": "string",
  • "spacing-type": "Margins",
  • "group": "string",
  • "priority": 0,
  • "rotation": "Any",
  • "templates": [
    ],
  • "placed": 0,
  • "total": 0,
  • "overrun": 0,
  • "properties": [
    ],
  • "layouts": [
    ],
  • "thumbnail": {
    }
}

Delete product with name {productname} from the project

path Parameters
productname
required
string
jobid
required
string

ID of the project

Responses

Response samples

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

Snap artwork to a given side of the product

path Parameters
productname
required
string
jobid
required
string

ID of the project

Request Body schema:
path
required
string

Local path of artwork file

front-page
integer <int32>

Page number of front artwork. When not specified defaults to page 1 unless back page is defined in which case only back side of die is snapped

back-page
integer <int32>

Page number of back artwork. Default: none

cut-ink
string

Name if spot cut line ink. Ink automatically detected when not specified

Responses

Request samples

Content type
{
  • "path": "string",
  • "front-page": 0,
  • "back-page": 0,
  • "cut-ink": "string"
}

Response samples

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

Export Tiling report of the given product

path Parameters
productname
required
string
jobid
required
string

ID of the project

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.

preset
string

Name of preset to use

Responses

Request samples

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

Response samples

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

Save project

path Parameters
jobid
required
string

ID of the project

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.

embed-artwork
boolean

Whether or not to embed artwork files in the saved job, defaults to current job preferences

Responses

Request samples

Content type
{
  • "idref": 0,
  • "path": "string",
  • "embed-artwork": true
}

Response samples

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

Save project template

path Parameters
jobid
required
string

ID of the project

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

Response samples

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

Run a script on the current project Deprecated

path Parameters
jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

name
string

Name of script in Scripts library including folder name(s)

object

Responses

Request samples

Content type
{
  • "idref": 0,
  • "name": "string",
  • "inputs": {
    }
}

Response samples

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

Snap artwork to products or die numbers in project

path Parameters
jobid
required
string

ID of the project

Request Body schema:
idref
integer <int32>

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

Array of objects (AutosnapProductDiesEntity)

List of artworks and autosnap targets

Responses

Request samples

Content type
{
  • "idref": 0,
  • "artworks": [
    ]
}

Response samples

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

Get uploaded project file by ID

path Parameters
fileid
required
string

ID of uploaded project file to get

jobid
required
string

ID of the project

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 project

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 project

Responses

Get all files currently uploaded to this project

path Parameters
jobid
required
string

ID of the project

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 project

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

Responses

Response samples

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

Projects API

Project 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)

template-path
string

Job template path for creating a new job from a template file or reporting which template was used to create a given job

Array of objects (propertyObject)

Custom properties

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,
  • "template-path": "string",
  • "properties": [
    ]
}

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": [
    ]
}

List repeat templates in the project

path Parameters
projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Add a repeat template to the project

path Parameters
projectid
required
string

ID of the project

Request Body schema:
name
required
string

Name of the repeat template

object (referenceDie-design)

Library reference

product
string

Name of the product in project to use for the die design

rows
required
integer <int32>

Rows

columns
required
integer <int32>

Columns

row-space
required
string

Row space

column-space
required
string

Column space

rotation
number <double>

Rotation

Responses

Request samples

Content type
{
  • "name": "string",
  • "die-design": {
    },
  • "product": "string",
  • "rows": 0,
  • "columns": 0,
  • "row-space": "string",
  • "column-space": "string",
  • "rotation": 0.1
}

Response samples

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

Create new bound product

path Parameters
projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

name
string

Unique name of the product

quantity
integer <int32>

Quantity of this product that needs to be produced

due-date
string <date-time>

Product due date

group
string

Optional product group used in Imposition AI

priority
integer <int32>

Optional priority of product starting from 1 as highest priority

object (scalar-range)

Scalar Range

color
string

Product color specified as RGB or ARGB hex value with optional leading hex ('#') symbol

description
string

Optional product description

notes
string

Optional notes to associate with product

object (resource)

Library resource

grade
string

Part stock grade

Array of objects (MarkAssetRef)

Optional product marks to apply to the front side of the product

Array of objects (MarkAssetRef)

Optional product marks to apply to the back side of the product

object (size)

Size object

artwork-file
string

Path to artwork file when creating product from artwork or snapping artwork into die

artwork-page
integer <int32>

Page of artwork to use, defaults to page 1 when not defined

grain
string
Enum: "Horizontal" "Vertical" "Consistent" "None"
object (rotation)

Rotation settings

object (bleed)

Bleed settings

object (spacing)

Spacing settings

object (offcut)

Offcut settings

color-source
string
Enum: "Artwork" "Specified"
color-analysis
string
Enum: "Fast" "Raster"
color-detection
string
Enum: "Cut" "Bleed"
Array of objects (PageColorResource)

Page colors for front side of flat products or all pages of bound and folded products

Array of objects (ProcessSettingResource)

Process settings

Array of objects (FoldingPatternRef)

Folding patterns to use

binding-method
string
Enum: "PerfectBound" "SaddleStitch" "None"
assembly-mode
string
Enum: "Manual" "LargestFirst"
pages
integer <int32>

Total number of pages field for bound and folded work

pages-per-section
integer <int32>

Number of pages per section for multi-section bound work

binding-edge
string
Enum: "Top" "Bottom" "Right" "Left"

Page binding edge for bound work

jog-edge
string
Enum: "Top" "Bottom" "Right" "Left"

Jog edge for bound work. When set, this edge must be perpendicular to the binding edge. Setting jog to Bottom for left- or right-bound work results in 'Foot to Foot' page orientation.

reading-order
string
Enum: "Normal" "Calendar"

Reading order of pages

self-cover
boolean

Whether bound part includes cover or not

object (trim)

Trim settings

object (creep)

Creep settings

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "name": "string",
  • "quantity": 0,
  • "due-date": "2019-08-24T14:15:22Z",
  • "group": "string",
  • "priority": 0,
  • "overruns": {
    },
  • "color": "string",
  • "description": "string",
  • "notes": "string",
  • "stock": {
    },
  • "grade": "string",
  • "marks": [
    ],
  • "back-marks": [
    ],
  • "size": {
    },
  • "artwork-file": "string",
  • "artwork-page": 0,
  • "grain": "Horizontal",
  • "rotation": {
    },
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "color-source": "Artwork",
  • "color-analysis": "Fast",
  • "color-detection": "Cut",
  • "colors": [
    ],
  • "process-settings": [
    ],
  • "folding-patterns": [
    ],
  • "binding-method": "PerfectBound",
  • "assembly-mode": "Manual",
  • "pages": 0,
  • "pages-per-section": 0,
  • "binding-edge": "Top",
  • "jog-edge": "Top",
  • "reading-order": "Normal",
  • "self-cover": true,
  • "trim": {
    },
  • "creep": {
    }
}

Response samples

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

Create new flat product

path Parameters
projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

name
string

Unique name of the product

quantity
integer <int32>

Quantity of this product that needs to be produced

due-date
string <date-time>

Product due date

group
string

Optional product group used in Imposition AI

priority
integer <int32>

Optional priority of product starting from 1 as highest priority

object (scalar-range)

Scalar Range

color
string

Product color specified as RGB or ARGB hex value with optional leading hex ('#') symbol

description
string

Optional product description

notes
string

Optional notes to associate with product

object (resource)

Library resource

grade
string

Part stock grade

Array of objects (MarkAssetRef)

Optional product marks to apply to the front side of the product

Array of objects (MarkAssetRef)

Optional product marks to apply to the back side of the product

object (size)

Size object

artwork-file
string

Path to artwork file when creating product from artwork or snapping artwork into die

artwork-page
integer <int32>

Page of artwork to use, defaults to page 1 when not defined

grain
string
Enum: "Horizontal" "Vertical" "Consistent" "None"
object (rotation)

Rotation settings

object (bleed)

Bleed settings

object (spacing)

Spacing settings

object (offcut)

Offcut settings

color-source
string
Enum: "Artwork" "Specified"
color-analysis
string
Enum: "Fast" "Raster"
color-detection
string
Enum: "Cut" "Bleed"
Array of objects (PageColorResource)

Page colors for front side of flat products or all pages of bound and folded products

Array of objects (ProcessSettingResource)

Process settings

page-handling
string
Enum: "OnePerFile" "OnePerPage" "OnePerTwoPages"
front-to-back
string
Enum: "None" "Copy" "Mirror"
die-design-source
string
Enum: "CAD" "ArtworkPaths" "ArtworkTrimbox" "CustomSize" "DieDesignLibrary" "PdfPlus"
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.

back-artwork-file
string

Path to artwork file for back side of product when creating product from artwork or snapping artwork into die

back-artwork-page
integer <int32>

Page of artwork to use for back side of product

object (resource)

Library resource

cad-file
string

Path of CAD file to use when defining product based on 1-up design in a CAD file

cad-design
string

Design name of 1-up CAD design in the CAD file, defaults to first 1-up in the CAD file when not defined

object (resource)

Library resource

autosnap-color
string

PDF color to use for autosnapping artwork into 1-up die on the front side of the product

autosnap-layer
string

PDF layer to use for autosnapping artwork into 1-up die on the front side of the product

back-autosnap-color
string

PDF color to use for autosnapping artwork into 1-up die on the back side of the product

back-autosnap-layer
string

PDF layer to use for autosnapping artwork into 1-up die on the back side of the product

Array of objects (PageColorResource)

Page back colors for back side of flat products

shape-handling
string
Enum: "Largest" "Multiple"
bundle-size
integer <int32>

Bundle size needed for product. When set, Imposition AI tools will ensure layouts including this product will have run length multiples of this bundle size

max-bundle-splits
integer <int32>

Max Bundle Splits allowed when bundle size is set. When set, this property controls whether a given full bundle can to be broken into smaller bundle sizes for optimization reasons with default value of 0 signifying no splitting allowed

object (reference)

Library reference

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "name": "string",
  • "quantity": 0,
  • "due-date": "2019-08-24T14:15:22Z",
  • "group": "string",
  • "priority": 0,
  • "overruns": {
    },
  • "color": "string",
  • "description": "string",
  • "notes": "string",
  • "stock": {
    },
  • "grade": "string",
  • "marks": [
    ],
  • "back-marks": [
    ],
  • "size": {
    },
  • "artwork-file": "string",
  • "artwork-page": 0,
  • "grain": "Horizontal",
  • "rotation": {
    },
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "color-source": "Artwork",
  • "color-analysis": "Fast",
  • "color-detection": "Cut",
  • "colors": [
    ],
  • "process-settings": [
    ],
  • "page-handling": "OnePerFile",
  • "front-to-back": "None",
  • "die-design-source": "CAD",
  • "scale-proportionally": true,
  • "back-artwork-file": "string",
  • "back-artwork-page": 0,
  • "die-design": {
    },
  • "cad-file": "string",
  • "cad-design": "string",
  • "die-import-preset": {
    },
  • "autosnap-color": "string",
  • "autosnap-layer": "string",
  • "back-autosnap-color": "string",
  • "back-autosnap-layer": "string",
  • "back-colors": [
    ],
  • "shape-handling": "Largest",
  • "bundle-size": 0,
  • "max-bundle-splits": 0,
  • "templates": {
    }
}

Response samples

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

Create new folded product

path Parameters
projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

name
string

Unique name of the product

quantity
integer <int32>

Quantity of this product that needs to be produced

due-date
string <date-time>

Product due date

group
string

Optional product group used in Imposition AI

priority
integer <int32>

Optional priority of product starting from 1 as highest priority

object (scalar-range)

Scalar Range

color
string

Product color specified as RGB or ARGB hex value with optional leading hex ('#') symbol

description
string

Optional product description

notes
string

Optional notes to associate with product

object (resource)

Library resource

grade
string

Part stock grade

Array of objects (MarkAssetRef)

Optional product marks to apply to the front side of the product

Array of objects (MarkAssetRef)

Optional product marks to apply to the back side of the product

object (size)

Size object

artwork-file
string

Path to artwork file when creating product from artwork or snapping artwork into die

artwork-page
integer <int32>

Page of artwork to use, defaults to page 1 when not defined

grain
string
Enum: "Horizontal" "Vertical" "Consistent" "None"
object (rotation)

Rotation settings

object (bleed)

Bleed settings

object (spacing)

Spacing settings

object (offcut)

Offcut settings

color-source
string
Enum: "Artwork" "Specified"
color-analysis
string
Enum: "Fast" "Raster"
color-detection
string
Enum: "Cut" "Bleed"
Array of objects (PageColorResource)

Page colors for front side of flat products or all pages of bound and folded products

Array of objects (ProcessSettingResource)

Process settings

Array of objects (FoldingPatternRef)

Folding patterns to use

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "name": "string",
  • "quantity": 0,
  • "due-date": "2019-08-24T14:15:22Z",
  • "group": "string",
  • "priority": 0,
  • "overruns": {
    },
  • "color": "string",
  • "description": "string",
  • "notes": "string",
  • "stock": {
    },
  • "grade": "string",
  • "marks": [
    ],
  • "back-marks": [
    ],
  • "size": {
    },
  • "artwork-file": "string",
  • "artwork-page": 0,
  • "grain": "Horizontal",
  • "rotation": {
    },
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "color-source": "Artwork",
  • "color-analysis": "Fast",
  • "color-detection": "Cut",
  • "colors": [
    ],
  • "process-settings": [
    ],
  • "folding-patterns": [
    ]
}

Response samples

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

Create new tiled product

path Parameters
projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

name
string

Unique name of the product

quantity
integer <int32>

Quantity of this product that needs to be produced

due-date
string <date-time>

Product due date

group
string

Optional product group used in Imposition AI

priority
integer <int32>

Optional priority of product starting from 1 as highest priority

object (scalar-range)

Scalar Range

color
string

Product color specified as RGB or ARGB hex value with optional leading hex ('#') symbol

description
string

Optional product description

notes
string

Optional notes to associate with product

object (resource)

Library resource

grade
string

Part stock grade

Array of objects (MarkAssetRef)

Optional product marks to apply to the front side of the product

Array of objects (MarkAssetRef)

Optional product marks to apply to the back side of the product

object (size)

Size object

artwork-file
string

Path to artwork file when creating product from artwork or snapping artwork into die

artwork-page
integer <int32>

Page of artwork to use, defaults to page 1 when not defined

grain
string
Enum: "Horizontal" "Vertical" "Consistent" "None"
object (rotation)

Rotation settings

object (bleed)

Bleed settings

object (spacing)

Spacing settings

object (offcut)

Offcut settings

color-source
string
Enum: "Artwork" "Specified"
color-analysis
string
Enum: "Fast" "Raster"
color-detection
string
Enum: "Cut" "Bleed"
Array of objects (PageColorResource)

Page colors for front side of flat products or all pages of bound and folded products

Array of objects (ProcessSettingResource)

Process settings

page-handling
string
Enum: "OnePerFile" "OnePerPage" "OnePerTwoPages"
front-to-back
string
Enum: "None" "Copy" "Mirror"
die-design-source
string
Enum: "CAD" "ArtworkPaths" "ArtworkTrimbox" "CustomSize" "DieDesignLibrary" "PdfPlus"
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.

back-artwork-file
string

Path to artwork file for back side of product when creating product from artwork or snapping artwork into die

back-artwork-page
integer <int32>

Page of artwork to use for back side of product

object (resource)

Library resource

cad-file
string

Path of CAD file to use when defining product based on 1-up design in a CAD file

cad-design
string

Design name of 1-up CAD design in the CAD file, defaults to first 1-up in the CAD file when not defined

object (resource)

Library resource

autosnap-color
string

PDF color to use for autosnapping artwork into 1-up die on the front side of the product

autosnap-layer
string

PDF layer to use for autosnapping artwork into 1-up die on the front side of the product

back-autosnap-color
string

PDF color to use for autosnapping artwork into 1-up die on the back side of the product

back-autosnap-layer
string

PDF layer to use for autosnapping artwork into 1-up die on the back side of the product

Array of objects (PageColorResource)

Page back colors for back side of flat products

object (resource)

Library resource

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "name": "string",
  • "quantity": 0,
  • "due-date": "2019-08-24T14:15:22Z",
  • "group": "string",
  • "priority": 0,
  • "overruns": {
    },
  • "color": "string",
  • "description": "string",
  • "notes": "string",
  • "stock": {
    },
  • "grade": "string",
  • "marks": [
    ],
  • "back-marks": [
    ],
  • "size": {
    },
  • "artwork-file": "string",
  • "artwork-page": 0,
  • "grain": "Horizontal",
  • "rotation": {
    },
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "color-source": "Artwork",
  • "color-analysis": "Fast",
  • "color-detection": "Cut",
  • "colors": [
    ],
  • "process-settings": [
    ],
  • "page-handling": "OnePerFile",
  • "front-to-back": "None",
  • "die-design-source": "CAD",
  • "scale-proportionally": true,
  • "back-artwork-file": "string",
  • "back-artwork-page": 0,
  • "die-design": {
    },
  • "cad-file": "string",
  • "cad-design": "string",
  • "die-import-preset": {
    },
  • "autosnap-color": "string",
  • "autosnap-layer": "string",
  • "back-autosnap-color": "string",
  • "back-autosnap-layer": "string",
  • "back-colors": [
    ],
  • "tiling": {
    }
}

Response samples

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

Get list of products

path Parameters
projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get list of bound parts

path Parameters
productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get bound part

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "grain": "Horizontal",
  • "pages": [
    ],
  • "process-settings": [
    ],
  • "rotation": {
    },
  • "page-size": {
    },
  • "sections": [
    ],
  • "binding-method": "PerfectBound",
  • "pages-per-section": 0,
  • "binding-edge": "Top",
  • "jog-edge": "Top",
  • "reading-order": "Normal",
  • "self-cover": true,
  • "trim": {
    },
  • "creep": {
    },
  • "allowed-folds": [
    ],
  • "type": "Flat",
  • "processes": [
    ],
  • "material": {
    }
}

Edit bound part

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

object (resource)

Library resource

grade
string

Part stock grade

grain
string
Enum: "Horizontal" "Vertical" "Consistent" "None"
object (rotation)

Rotation settings

object (bleed)

Bleed settings

object (spacing)

Spacing settings

object (offcut)

Offcut settings

object (resource)

Library resource

binding-method
string
Enum: "PerfectBound" "SaddleStitch" "None"
binding-edge
string
Enum: "Top" "Bottom" "Right" "Left"

Binding edge of this part

jog-edge
string
Enum: "Top" "Bottom" "Right" "Left"

Jog edge of this part

reading-order
string
Enum: "Normal" "Calendar"

Reading order of this part

self-cover
boolean

Whether this part has a self cover or not

object (trim)

Trim settings

object (n-up)

N-up settings

object (creep)

Creep settings

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "stock": {
    },
  • "grade": "string",
  • "grain": "Horizontal",
  • "rotation": {
    },
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "page-size": {
    },
  • "binding-method": "PerfectBound",
  • "binding-edge": "Top",
  • "jog-edge": "Top",
  • "reading-order": "Normal",
  • "self-cover": true,
  • "trim": {
    },
  • "n-up": {
    },
  • "creep": {
    }
}

Response samples

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

Get list of sections. Only applicable to bound parts

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Create new section

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
binding-method
string
Enum: "PerfectBound" "SaddleStitch" "None"

Responses

Request samples

Content type
{
  • "binding-method": "PerfectBound"
}

Response samples

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

Get section

path Parameters
sectionindex
required
integer <int32>

Index of section

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "id": "string",
  • "binding-method": "PerfectBound",
  • "signatures": [
    ]
}

Delete section

path Parameters
sectionindex
required
integer <int32>

Index of section

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

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

Edit section

path Parameters
sectionindex
required
integer <int32>

Index of section

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
binding-method
string
Enum: "PerfectBound" "SaddleStitch" "None"

Responses

Request samples

Content type
{
  • "binding-method": "PerfectBound"
}

Response samples

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

Get list of signatures

path Parameters
sectionindex
required
integer <int32>

Index of section

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Create new signature

path Parameters
sectionindex
required
integer <int32>

Index of section

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
index
integer <int32>

Index to insert new signatures at. Indexes start from 1. If this is null or out of range, signatures will be added to the end

required
object (reference)

Library reference

count
integer <int32>

Number of signatures to add

Responses

Request samples

Content type
{
  • "index": 0,
  • "pattern": {
    },
  • "count": 0
}

Response samples

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

Get bound signature

path Parameters
signatureindex
required
integer <int32>

Index of signature

sectionindex
required
integer <int32>

Index of section

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "die-design": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "type": "Flat",
  • "folding-pattern": {
    },
  • "total": 0,
  • "placed": 0,
  • "overrun": 0,
  • "fulfilled": true,
  • "layouts": {
    }
}

Delete signature

path Parameters
signatureindex
required
integer <int32>

Index of signature

sectionindex
required
integer <int32>

Index of section

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

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

Get product with name of {productname}

path Parameters
productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "index": 0,
  • "name": "string",
  • "color": "string",
  • "ordered": 0,
  • "description": "string",
  • "notes": "string",
  • "die-name": "string",
  • "die-source": "string",
  • "die-path": "string",
  • "stock": "string",
  • "grade": "string",
  • "grain": "Horizontal",
  • "width": "string",
  • "height": "string",
  • "spacing-type": "Margins",
  • "group": "string",
  • "priority": 0,
  • "rotation": "Any",
  • "templates": [
    ],
  • "placed": 0,
  • "total": 0,
  • "overrun": 0,
  • "properties": [
    ],
  • "layouts": [
    ],
  • "thumbnail": {
    }
}

Delete product

path Parameters
productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

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

Edit product

path Parameters
productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

name
string

Unique name of the product

quantity
integer <int32>

Quantity of this product that needs to be produced

due-date
string <date-time>

Product due date

group
string

Optional product group used in Imposition AI

priority
integer <int32>

Optional priority of product starting from 1 as highest priority

object (scalar-range)

Scalar Range

color
string

Product color specified as RGB or ARGB hex value with optional leading hex ('#') symbol

description
string

Optional product description

notes
string

Optional notes to associate with product

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "name": "string",
  • "quantity": 0,
  • "due-date": "2019-08-24T14:15:22Z",
  • "group": "string",
  • "priority": 0,
  • "overruns": {
    },
  • "color": "string",
  • "description": "string",
  • "notes": "string"
}

Response samples

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

Get list of flat parts

path Parameters
productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get list of flats

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get flat

path Parameters
flatindex
required
integer <int32>

Index of flat

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "die-design": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "bundle-size": 0,
  • "max-bundle-splits": 0,
  • "type": "Flat",
  • "total": 0,
  • "placed": 0,
  • "overrun": 0,
  • "fulfilled": true,
  • "layouts": {
    }
}

Edit flat

path Parameters
flatindex
required
integer <int32>

Index of flat

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

object (bleed)

Bleed settings

required
object (spacing)

Spacing settings

object (offcut)

Offcut settings

x-scale
number <double>

Component x-scale

y-scale
number <double>

Component y-scale

object (resource)

Library resource

bundle-size
integer <int32>

Bundle size

max-bundle-splits
integer <int32>

Max Bundle Splits

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "x-scale": 0.1,
  • "y-scale": 0.1,
  • "die-design": {
    },
  • "bundle-size": 0,
  • "max-bundle-splits": 0
}

Response samples

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

Get flat part

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "grain": "Horizontal",
  • "pages": [
    ],
  • "process-settings": [
    ],
  • "rotation": {
    },
  • "flat": {
    },
  • "templates": [
    ],
  • "type": "Flat",
  • "processes": [
    ],
  • "material": {
    }
}

Edit flat part

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

object (resource)

Library resource

grade
string

Part stock grade

grain
string
Enum: "Horizontal" "Vertical" "Consistent" "None"
object (rotation)

Rotation settings

object (bleed)

Bleed settings

object (spacing)

Spacing settings

object (offcut)

Offcut settings

object (reference)

Library reference

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "stock": {
    },
  • "grade": "string",
  • "grain": "Horizontal",
  • "rotation": {
    },
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "templates": {
    }
}

Response samples

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

Get list of folded parts

path Parameters
productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get folded part

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "grain": "Horizontal",
  • "pages": [
    ],
  • "process-settings": [
    ],
  • "rotation": {
    },
  • "page-size": {
    },
  • "signature": {
    },
  • "type": "Flat",
  • "processes": [
    ],
  • "material": {
    }
}

Edit folded part

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

object (resource)

Library resource

grade
string

Part stock grade

grain
string
Enum: "Horizontal" "Vertical" "Consistent" "None"
object (rotation)

Rotation settings

object (bleed)

Bleed settings

object (spacing)

Spacing settings

object (offcut)

Offcut settings

object (resource)

Library resource

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "stock": {
    },
  • "grade": "string",
  • "grain": "Horizontal",
  • "rotation": {
    },
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "page-size": {
    }
}

Response samples

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

Get list of signatures

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get folded signature

path Parameters
signatureindex
required
integer <int32>

Index of signature

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "die-design": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "type": "Flat",
  • "folding-pattern": {
    },
  • "total": 0,
  • "placed": 0,
  • "overrun": 0,
  • "fulfilled": true,
  • "layouts": {
    }
}

Get list of parts

path Parameters
productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get list of components

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get component

path Parameters
componentindex
required
integer <int32>

Index of component

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
Example
{
  • "id": "string",
  • "name": "string",
  • "die-design": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "bundle-size": 0,
  • "max-bundle-splits": 0,
  • "type": "Flat",
  • "total": 0,
  • "placed": 0,
  • "overrun": 0,
  • "fulfilled": true,
  • "layouts": {
    }
}

Edit component

path Parameters
componentindex
required
integer <int32>

Index of component

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

object (bleed)

Bleed settings

required
object (spacing)

Spacing settings

object (offcut)

Offcut settings

x-scale
number <double>

Component x-scale

y-scale
number <double>

Component y-scale

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "x-scale": 0.1,
  • "y-scale": 0.1
}

Response samples

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

Get part

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
Example
{
  • "id": "string",
  • "name": "string",
  • "grain": "Horizontal",
  • "pages": [
    ],
  • "process-settings": [
    ],
  • "rotation": {
    },
  • "flat": {
    },
  • "templates": [
    ],
  • "type": "Flat",
  • "processes": [
    ],
  • "material": {
    }
}

Edit part

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "properties": [
    ]
}

Response samples

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

Get list of pages

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Create new pages

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
object (size)

Size object

object (margins)

Margins

count
integer <int32>

Number of pages to add

Responses

Request samples

Content type
{
  • "size": {
    },
  • "bleed": {
    },
  • "count": 0
}

Response samples

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

Assign artwork to pages

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
path
string

Path to file

Responses

Request samples

Content type
{
  • "path": "string"
}

Response samples

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

Get page color by index

path Parameters
colorindex
required
integer <int32>

Index of color

pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "name": "string",
  • "type": "CMYK",
  • "values": [
    ],
  • "coverage": 0.1,
  • "process": {
    }
}

Edit page color

path Parameters
colorindex
required
integer <int32>

Index of color

pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
name
required
string

Color (spot) name

type
string
Enum: "CMYK" "Lab" "RGB"
values
Array of numbers <double> [ items <double > ]

Color values

coverage
number <double>

Color coverage

required
object (process)

Process

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "CMYK",
  • "values": [
    ],
  • "coverage": 0.1,
  • "process": {
    }
}

Response samples

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

Get list of colors in the page

path Parameters
pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get page

path Parameters
pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

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

Delete page

path Parameters
pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

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

Edit page

path Parameters
pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

color-analysis
string
Enum: "Fast" "Raster"
color-detection
string
Enum: "Cut" "Bleed"
color-source
string
Enum: "Artwork" "Specified"
mark-color-source
string
Enum: "PageColors" "ArtworkColors"
autosnap
boolean

Autosnap

autosnap-color
string

Autosnap Color

autosnap-layer
string

Autosnap Layer

object (resource)

Library resource

object (point)

Point (x,y coordinates)

rotation
number <double>

Rotation

x-scale
number <double>

X-Scale

y-scale
number <double>

Y-Scale

visible
boolean

Visible

locked
boolean

Locked

object (margins)

Margins

object (ScalarValue)

Circumference

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "color-analysis": "Fast",
  • "color-detection": "Cut",
  • "color-source": "Artwork",
  • "mark-color-source": "PageColors",
  • "autosnap": true,
  • "autosnap-color": "string",
  • "autosnap-layer": "string",
  • "size": {
    },
  • "position": {
    },
  • "rotation": 0.1,
  • "x-scale": 0.1,
  • "y-scale": 0.1,
  • "visible": true,
  • "locked": true,
  • "bleed": {
    },
  • "creep": {
    }
}

Response samples

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

Delete page file

path Parameters
pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

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

Edit page file

path Parameters
pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
path
string

File path

number
integer <int32>

File page number

Responses

Request samples

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

Response samples

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

Get list of layers in the page

path Parameters
pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get page layer by index

path Parameters
layerindex
required
integer <int32>

Index of layer

pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "visible": true,
  • "name": "string",
  • "language": "string",
  • "locked": true
}

Edit page layer

path Parameters
layerindex
required
integer <int32>

Index of layer

pageindex
required
integer <int32>

Index of page

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
visible
boolean

Layer visibility

Responses

Request samples

Content type
{
  • "visible": true
}

Response samples

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

Get list of tiled parts

path Parameters
productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get tiled part

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "grain": "Horizontal",
  • "pages": [
    ],
  • "process-settings": [
    ],
  • "rotation": {
    },
  • "die-design": {
    },
  • "tiling": {
    },
  • "tiles": [
    ],
  • "type": "Flat",
  • "processes": [
    ],
  • "material": {
    }
}

Edit tiled part

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

object (resource)

Library resource

grade
string

Part stock grade

grain
string
Enum: "Horizontal" "Vertical" "Consistent" "None"
object (rotation)

Rotation settings

object (bleed)

Bleed settings

object (spacing)

Spacing settings

object (offcut)

Offcut settings

object (resource)

Library resource

x-scale
number <double>

X-scale of this tiled part

y-scale
number <double>

Y-scale of this tiled part

object (resource)

Library resource

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "stock": {
    },
  • "grade": "string",
  • "grain": "Horizontal",
  • "rotation": {
    },
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "die-design": {
    },
  • "x-scale": 0.1,
  • "y-scale": 0.1,
  • "tiling-preset": {
    }
}

Response samples

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

Get list of tiles

path Parameters
partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Get tile

path Parameters
tileindex
required
integer <int32>

Index of tile

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "die-design": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "tile": {
    },
  • "type": "Flat",
  • "index": 0,
  • "total": 0,
  • "placed": 0,
  • "overrun": 0,
  • "fulfilled": true,
  • "layouts": {
    }
}

Edit tile

path Parameters
tileindex
required
integer <int32>

Index of tile

partindex
required
integer <int32>

Index of part

productname
required
string

Product name

projectid
required
string

ID of the project

Request Body schema:
Array of objects (propertyObject)

Custom properties

object (bleed)

Bleed settings

required
object (spacing)

Spacing settings

object (offcut)

Offcut settings

x-scale
number <double>

Component x-scale

y-scale
number <double>

Component y-scale

object (resource)

Library resource

object (tile)

Single tile definition

Responses

Request samples

Content type
{
  • "properties": [
    ],
  • "bleed": {
    },
  • "spacing": {
    },
  • "offcut": {
    },
  • "x-scale": 0.1,
  • "y-scale": 0.1,
  • "die-design": {
    },
  • "tile": {
    }
}

Response samples

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

Update repeat template in the project with the nameprovided

path Parameters
name
required
string

Repeat template name

projectid
required
string

ID of the project

Request Body schema:
name
required
string

Name of the repeat template

object (referenceDie-design)

Library reference

product
string

Name of the product in project to use for the die design

rows
required
integer <int32>

Rows

columns
required
integer <int32>

Columns

row-space
required
string

Row space

column-space
required
string

Column space

rotation
number <double>

Rotation

Responses

Request samples

Content type
{
  • "name": "string",
  • "die-design": {
    },
  • "product": "string",
  • "rows": 0,
  • "columns": 0,
  • "row-space": "string",
  • "column-space": "string",
  • "rotation": 0.1
}

Response samples

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

Remove repeat template in the project with the nameprovided

path Parameters
name
required
string

Repeat template name

projectid
required
string

ID of the project

Responses

Response samples

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

Run a script on the current project

path Parameters
projectid
required
string

ID of the project

Request Body schema:
object (resourceScriptAsset)

Library resource

data
string

Optional data to pass into the script (for example a json blob)

Responses

Request samples

Content type
{
  • "script": {
    },
  • "data": "string"
}

Response samples

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

Get list of all stocks stored in the project

path Parameters
projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Add new stock to project

path Parameters
projectid
required
string

ID of the project

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

object (reference)

Library reference

vendor
string

Stock vendor name

Array of objects (grade)

List of grades specified for this stock

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "stock-type": {
    },
  • "vendor": "string",
  • "grades": [
    ],
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get stock stored in project by ID

path Parameters
assetid
required
string

ID of asset to get

projectid
required
string

ID of the project

Responses

Response samples

Content type
Example
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "allow-pass-through": true,
  • "connections": [
    ],
  • "costing": {
    },
  • "capabilities": {
    },
  • "script": {
    },
  • "manufacturer": "string",
  • "enforce-feed-type": true,
  • "media-rules": {
    },
  • "placement": {
    },
  • "operation": {
    },
  • "front-units": {
    },
  • "single-pass-double-sided": true,
  • "back-units": {
    },
  • "double-sided-speed-reduction": "string",
  • "gripper": "string",
  • "sheetTurn": "Turn",
  • "type": "SheetFedDigitalPress",
  • "feed-type": "Roll",
  • "process-type": {
    },
  • "path": "string"
}

Delete stock from the project

path Parameters
assetid
required
string

ID of asset to delete

projectid
required
string

ID of the project

Responses

Response samples

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

Get list of all things stored in the project

path Parameters
projectid
required
string

ID of the project

Responses

Response samples

Content type
[
  • {
    }
]

Add new thing to project

path Parameters
projectid
required
string

ID of the project

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

allow-pass-through
boolean

Allow pass-through

Array of objects (connector)

Direct connections to other things

required
object (sfdp-costing)

Sheet-fed Digital Press Costing

required
object (press-capabilities)

Press Capabilities

object (reference)

Library reference

manufacturer
required
string

Manufacturer

enforce-feed-type
boolean

When enabled, ensures that Imposition AI will only use rolls or sheets as dictated by whether this device's feed type is roll-fed or sheet-fed

required
object (press-media-rules)

Press media rules

required
object (press-placement)

Press Placement

required
object (operation-modes)

Operation Modes

required
object (press-units)

Press Units

single-pass-double-sided
boolean

Single Pass Double Sided

object (press-units)

Press Units

double-sided-speed-reduction
string

Double Sided Speed Reduction

gripper
string

Gripper

sheetTurn
required
string
Enum: "Turn" "Tumble"
type
required
string
feed-type
required
string
Enum: "Roll" "Sheet"
required
object (process-type)

Process Type

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
Example
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "allow-pass-through": true,
  • "connections": [
    ],
  • "costing": {
    },
  • "capabilities": {
    },
  • "script": {
    },
  • "manufacturer": "string",
  • "enforce-feed-type": true,
  • "media-rules": {
    },
  • "placement": {
    },
  • "operation": {
    },
  • "front-units": {
    },
  • "single-pass-double-sided": true,
  • "back-units": {
    },
  • "double-sided-speed-reduction": "string",
  • "gripper": "string",
  • "sheetTurn": "Turn",
  • "type": "SheetFedDigitalPress",
  • "feed-type": "Roll",
  • "process-type": {
    },
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get thing stored in project by ID

path Parameters
assetid
required
string

ID of asset to get

projectid
required
string

ID of the project

Responses

Response samples

Content type
Example
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "allow-pass-through": true,
  • "connections": [
    ],
  • "costing": {
    },
  • "capabilities": {
    },
  • "script": {
    },
  • "manufacturer": "string",
  • "enforce-feed-type": true,
  • "media-rules": {
    },
  • "placement": {
    },
  • "operation": {
    },
  • "front-units": {
    },
  • "single-pass-double-sided": true,
  • "back-units": {
    },
  • "double-sided-speed-reduction": "string",
  • "gripper": "string",
  • "sheetTurn": "Turn",
  • "type": "SheetFedDigitalPress",
  • "feed-type": "Roll",
  • "process-type": {
    },
  • "path": "string"
}

Delete thing from the project

path Parameters
assetid
required
string

ID of asset to delete

projectid
required
string

ID of the project

Responses

Response samples

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

Run a script

Request Body schema:
object (resourceScriptAsset)

Library resource

data
string

Optional data to pass into the script (for example a json blob)

Responses

Request samples

Content type
{
  • "script": {
    },
  • "data": "string"
}

Response samples

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

Libraries API

Library management

Get die design by ID

path Parameters
diedesignid
required
string

ID of die design to get

query Parameters
thumb
boolean
Default: false

Include thumbnail image or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "path": "string",
  • "width": "string",
  • "height": "string",
  • "thumbnail": {
    }
}

Delete die design

path Parameters
diedesignid
required
string

ID of die design to delete

Responses

Response samples

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

Get list of all die designs

query Parameters
thumb
boolean
Default: false

Include thumbnail image or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

Responses

Response samples

Content type
[
  • {
    }
]

Import new die design

Request Body schema:
name
string

Name of template asset to create including folders if desired. If name is not specified, file name minus extension will be used as the name.

id
string

ID of asset to use. If not specified a unique ID will be generated.

external-id
string

Optional external ID of media item

description
string

Asset description

create-folder
boolean

Boolean controlling whether to create a folder when folder or parent folder(s) does not exist. By default non-existent folders are not created automatically.

path
required
string

Full path of template file to import

preset
string

Name of preset to use during import

die-name
string

Name of die in CAD file to import. By default if die name is not specified and the CAD file contains multiple dies, the first die listed in the CAD data is used.

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "create-folder": true,
  • "path": "string",
  • "preset": "string",
  • "die-name": "string"
}

Response samples

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

Get list of all folding patterns Deprecated

Responses

Response samples

Content type
[
  • {
    }
]

Get folding pattern by ID

path Parameters
foldingpatternid
required
string

ID of folding pattern to get

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "columns": 0,
  • "rows": 0,
  • "folds": [
    ],
  • "page-mappings": { },
  • "path": "string"
}

Edit folding pattern

path Parameters
foldingpatternid
required
string

ID of folding pattern to edit

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

columns
required
integer <int32>

Number of columns

rows
required
integer <int32>

Number of rows

required
Array of objects (fold)

Folds in this signature

page-mappings
object (page-mappings)

Folding pattern custom page mappings

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "columns": 0,
  • "rows": 0,
  • "folds": [
    ],
  • "page-mappings": { },
  • "path": "string",
  • "properties": [
    ]
}

Delete folding pattern

path Parameters
foldingpatternid
required
string

ID of folding pattern to delete

Responses

Response samples

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

Get list of all folding patterns

Responses

Response samples

Content type
[
  • {
    }
]

Add new folding pattern

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

columns
required
integer <int32>

Number of columns

rows
required
integer <int32>

Number of rows

required
Array of objects (fold)

Folds in this signature

page-mappings
object (page-mappings)

Folding pattern custom page mappings

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "columns": 0,
  • "rows": 0,
  • "folds": [
    ],
  • "page-mappings": { },
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get list of all mark sets

Responses

Response samples

Content type
[
  • {
    }
]

Get list of all marks

Responses

Response samples

Content type
[
  • {
    }
]

Get mark by ID

path Parameters
markid
required
string

ID of mark to get

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "path": "string"
}

Edit mark

path Parameters
markid
required
string

ID of mark to edit

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

required
object (mark-placement)

Mark placement settings

required
object (PropertyRuleGroup)

Mark conditional rules

required
object (shape-mark-props)

Shape mark props

shape-type
required
string
Enum: "Line" "Rectangle" "Ellipse" "Cross" "CrossHair" "SquareCross" "CmykCross" "SquareCrossFilled" "Target" "TargetCmyk" "HalfTarget" "Corner1" "SGArrowLeft" "SGArrowRight" "SGParallelGuideLeft" "SGParallelGuideRight"
type
required
string
path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
Example
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "placement": {
    },
  • "conditions": {
    },
  • "mark-appearance": {
    },
  • "shape-type": "Line",
  • "type": "ShapeMark",
  • "path": "string",
  • "properties": [
    ]
}

Delete mark

path Parameters
markid
required
string

ID of mark to delete

Responses

Response samples

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

Get list of all marks

Responses

Response samples

Content type
[
  • {
    }
]

Add new mark

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

required
object (mark-placement)

Mark placement settings

required
object (PropertyRuleGroup)

Mark conditional rules

required
object (shape-mark-props)

Shape mark props

shape-type
required
string
Enum: "Line" "Rectangle" "Ellipse" "Cross" "CrossHair" "SquareCross" "CmykCross" "SquareCrossFilled" "Target" "TargetCmyk" "HalfTarget" "Corner1" "SGArrowLeft" "SGArrowRight" "SGParallelGuideLeft" "SGParallelGuideRight"
type
required
string
path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
Example
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "placement": {
    },
  • "conditions": {
    },
  • "mark-appearance": {
    },
  • "shape-type": "Line",
  • "type": "ShapeMark",
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get mode by ID

path Parameters
modeid
required
string

ID of mode to get

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "path": "string"
}

Edit mode

path Parameters
modeid
required
string

ID of mode to edit

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "path": "string",
  • "properties": [
    ]
}

Delete mode

path Parameters
modeid
required
string

ID of mode to delete

Responses

Response samples

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

Get list of all modes

Responses

Response samples

Content type
[
  • {
    }
]

Add new mode

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get plate by ID

path Parameters
plateid
required
string

ID of plate to get

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "width": "string",
  • "height": "string",
  • "punch-height": "string",
  • "h-distortion": 0.1,
  • "v-distortion": 0.1,
  • "price": 0.1
}

Edit plate

path Parameters
plateid
required
string

ID of plate to edit

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

width
string

Plate width

height
string

Plate height

punch-height
string

Punch height of plate

h-distortion
number <double>

Horizontal distortion of plate

v-distortion
number <double>

Vertical distortion of plate

price
number <double>

Price of one plate

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "width": "string",
  • "height": "string",
  • "punch-height": "string",
  • "h-distortion": 0.1,
  • "v-distortion": 0.1,
  • "price": 0.1
}

Delete plate

path Parameters
plateid
required
string

ID of plate to delete

Responses

Response samples

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

Get list of all plates

Responses

Response samples

Content type
[
  • {
    }
]

Add new plate

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

width
string

Plate width

height
string

Plate height

punch-height
string

Punch height of plate

h-distortion
number <double>

Horizontal distortion of plate

v-distortion
number <double>

Vertical distortion of plate

price
number <double>

Price of one plate

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "width": "string",
  • "height": "string",
  • "punch-height": "string",
  • "h-distortion": 0.1,
  • "v-distortion": 0.1,
  • "price": 0.1
}

Response samples

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

Get press by ID

path Parameters
pressid
required
string

ID of press to get

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "manufacturer": "string",
  • "speed": 0.1,
  • "speed-units": "SheetsPerMinute",
  • "cost-per-hour": 0.1,
  • "make-ready-time": 0.1,
  • "number-of-colors": 0,
  • "min-run-length": 0,
  • "back-single-pass": true,
  • "workstyle": "FlatWork",
  • "back-number-of-colors": 0,
  • "back-speed-reduction": 0.1,
  • "multi-pass": true,
  • "min-sheet-width": "string",
  • "max-sheet-width": "string",
  • "min-sheet-height": "string",
  • "max-sheet-height": "string",
  • "min-stock-thickness": "string",
  • "max-stock-thickness": "string",
  • "min-stock-weight": 0.1,
  • "max-stock-weight": 0.1,
  • "weight-units": "GSM",
  • "weight-type": "Text",
  • "sheet-handling": "None",
  • "image-margins": {
    },
  • "content-margins": {
    },
  • "gripper": "string",
  • "default-plate": "string"
}

Edit press

path Parameters
pressid
required
string

ID of press to edit

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Press description

manufacturer
string

Press manufacturer

speed
number <double>

Speed of press in speed units

speed-units
string
Enum: "SheetsPerMinute" "SheetsPerHour" "FeetPerMinute" "MetersPerMinute" "FeetPerHour" "MetersPerHour" "SquareFeetPerHour" "SquareMetersPerHour"

Speed units

cost-per-hour
number <double>

Cost to operate this press per hour

make-ready-time
number <double>

Per-color make ready time in minutes

number-of-colors
integer <int32>

Maximum number of colors supported on this press

min-run-length
integer <int32>

Minimum run length allowed for layouts

back-single-pass
boolean

Whether this press supports single-pass double sided printing

workstyle
string
Enum: "FlatWork" "Sheetwise" "Perfecting" "WorkAndTurn" "WorkAndTumble"

Workstyle of single-pass double sided printing unit

back-number-of-colors
integer <int32>

Maximum number of colors supported on back side when doing single-pass double sided printing

back-speed-reduction
number <double>

Percentage of speed reduction when doing single-pass double sided printing

multi-pass
boolean

Whether to allow multiple passes through this press

min-sheet-width
string

Minumum sheet width supported by this press

max-sheet-width
string

Maximum sheet width supported by this press

min-sheet-height
string

Minumum sheet height supported by this press

max-sheet-height
string

Minumum sheet width supported by this press

min-stock-thickness
string

Minimum stock thickness supported by this press

max-stock-thickness
string

Maximum stock thickness supported by this press

min-stock-weight
number <double>

Minimum stock weight supported by this press

max-stock-weight
number <double>

Maximum stock weight supported by this press

weight-units
string
Enum: "GSM" "Lb"

Units of min/max stock weight defined for this press. Defaults to GSM when not specified.

weight-type
string
Enum: "Text" "Book" "Bond" "Offset" "Cover" "Bristol" "Index" "Tag" "Card"

Weight type for American standard stock weight system for min/max stock weight defined for this press. Defaults to Text when not specified.

sheet-handling
string
Enum: "None" "LongEdgeHorizontal" "LongEdgeVertical"

Sheet handling option for sheet orientation on this press. Defaults to None when not specified.

object (MarginsEntity)

Left, top, right and bottom scalar margins entity

object (MarginsEntity)

Left, top, right and bottom scalar margins entity

gripper
string

Gripper distance from bottom of sheet

default-plate
string

Optional default plate to use when applying this press to a layout

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "manufacturer": "string",
  • "speed": 0.1,
  • "speed-units": "SheetsPerMinute",
  • "cost-per-hour": 0.1,
  • "make-ready-time": 0.1,
  • "number-of-colors": 0,
  • "min-run-length": 0,
  • "back-single-pass": true,
  • "workstyle": "FlatWork",
  • "back-number-of-colors": 0,
  • "back-speed-reduction": 0.1,
  • "multi-pass": true,
  • "min-sheet-width": "string",
  • "max-sheet-width": "string",
  • "min-sheet-height": "string",
  • "max-sheet-height": "string",
  • "min-stock-thickness": "string",
  • "max-stock-thickness": "string",
  • "min-stock-weight": 0.1,
  • "max-stock-weight": 0.1,
  • "weight-units": "GSM",
  • "weight-type": "Text",
  • "sheet-handling": "None",
  • "image-margins": {
    },
  • "content-margins": {
    },
  • "gripper": "string",
  • "default-plate": "string"
}

Delete press

path Parameters
pressid
required
string

ID of press to delete

Responses

Response samples

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

Get list of all presses

Responses

Response samples

Content type
[
  • {
    }
]

Add new press

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Press description

manufacturer
string

Press manufacturer

speed
number <double>

Speed of press in speed units

speed-units
string
Enum: "SheetsPerMinute" "SheetsPerHour" "FeetPerMinute" "MetersPerMinute" "FeetPerHour" "MetersPerHour" "SquareFeetPerHour" "SquareMetersPerHour"

Speed units

cost-per-hour
number <double>

Cost to operate this press per hour

make-ready-time
number <double>

Per-color make ready time in minutes

number-of-colors
integer <int32>

Maximum number of colors supported on this press

min-run-length
integer <int32>

Minimum run length allowed for layouts

back-single-pass
boolean

Whether this press supports single-pass double sided printing

workstyle
string
Enum: "FlatWork" "Sheetwise" "Perfecting" "WorkAndTurn" "WorkAndTumble"

Workstyle of single-pass double sided printing unit

back-number-of-colors
integer <int32>

Maximum number of colors supported on back side when doing single-pass double sided printing

back-speed-reduction
number <double>

Percentage of speed reduction when doing single-pass double sided printing

multi-pass
boolean

Whether to allow multiple passes through this press

min-sheet-width
string

Minumum sheet width supported by this press

max-sheet-width
string

Maximum sheet width supported by this press

min-sheet-height
string

Minumum sheet height supported by this press

max-sheet-height
string

Minumum sheet width supported by this press

min-stock-thickness
string

Minimum stock thickness supported by this press

max-stock-thickness
string

Maximum stock thickness supported by this press

min-stock-weight
number <double>

Minimum stock weight supported by this press

max-stock-weight
number <double>

Maximum stock weight supported by this press

weight-units
string
Enum: "GSM" "Lb"

Units of min/max stock weight defined for this press. Defaults to GSM when not specified.

weight-type
string
Enum: "Text" "Book" "Bond" "Offset" "Cover" "Bristol" "Index" "Tag" "Card"

Weight type for American standard stock weight system for min/max stock weight defined for this press. Defaults to Text when not specified.

sheet-handling
string
Enum: "None" "LongEdgeHorizontal" "LongEdgeVertical"

Sheet handling option for sheet orientation on this press. Defaults to None when not specified.

object (MarginsEntity)

Left, top, right and bottom scalar margins entity

object (MarginsEntity)

Left, top, right and bottom scalar margins entity

gripper
string

Gripper distance from bottom of sheet

default-plate
string

Optional default plate to use when applying this press to a layout

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "manufacturer": "string",
  • "speed": 0.1,
  • "speed-units": "SheetsPerMinute",
  • "cost-per-hour": 0.1,
  • "make-ready-time": 0.1,
  • "number-of-colors": 0,
  • "min-run-length": 0,
  • "back-single-pass": true,
  • "workstyle": "FlatWork",
  • "back-number-of-colors": 0,
  • "back-speed-reduction": 0.1,
  • "multi-pass": true,
  • "min-sheet-width": "string",
  • "max-sheet-width": "string",
  • "min-sheet-height": "string",
  • "max-sheet-height": "string",
  • "min-stock-thickness": "string",
  • "max-stock-thickness": "string",
  • "min-stock-weight": 0.1,
  • "max-stock-weight": 0.1,
  • "weight-units": "GSM",
  • "weight-type": "Text",
  • "sheet-handling": "None",
  • "image-margins": {
    },
  • "content-margins": {
    },
  • "gripper": "string",
  • "default-plate": "string"
}

Response samples

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

Get process type by ID

path Parameters
processtypeid
required
string

ID of process type to get

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "process": {
    },
  • "path": "string"
}

Edit process type

path Parameters
processtypeid
required
string

ID of process type to edit

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

required
object (reference)

Library reference

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "process": {
    },
  • "path": "string",
  • "properties": [
    ]
}

Delete process type

path Parameters
processtypeid
required
string

ID of process type to delete

Responses

Response samples

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

Get list of all process types

Responses

Response samples

Content type
[
  • {
    }
]

Add new process type

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

required
object (reference)

Library reference

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "process": {
    },
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get process by ID

path Parameters
processid
required
string

ID of process to get

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "path": "string"
}

Edit process

path Parameters
processid
required
string

ID of process to edit

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "path": "string",
  • "properties": [
    ]
}

Delete process

path Parameters
processid
required
string

ID of process to delete

Responses

Response samples

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

Get list of all processes

Responses

Response samples

Content type
[
  • {
    }
]

Add new process

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get script by ID

path Parameters
scriptid
required
string

ID of script to get

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "code": "string",
  • "script-file": "string",
  • "path": "string"
}

Edit script

path Parameters
scriptid
required
string

ID of script to edit

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

code
string

The script code

script-file
string

The file the script came from (if any)

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "code": "string",
  • "script-file": "string",
  • "path": "string",
  • "properties": [
    ]
}

Delete script

path Parameters
scriptid
required
string

ID of script to delete

Responses

Response samples

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

Get list of all scripts

Responses

Response samples

Content type
[
  • {
    }
]

Add new script

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

code
string

The script code

script-file
string

The file the script came from (if any)

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "code": "string",
  • "script-file": "string",
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get stock type by ID

path Parameters
stocktypeid
required
string

ID of stock type to get

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "path": "string"
}

Edit stock type

path Parameters
stocktypeid
required
string

ID of stock type to edit

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "path": "string",
  • "properties": [
    ]
}

Delete stock type

path Parameters
stocktypeid
required
string

ID of stock type to delete

Responses

Response samples

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

Get list of all stock types

Responses

Response samples

Content type
[
  • {
    }
]

Add new stock type

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get stock by ID Deprecated

path Parameters
stockid
required
string

ID of stock to get

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "stock-type": {
    },
  • "vendor": "string",
  • "grades": [
    ]
}

Edit stock Deprecated

path Parameters
stockid
required
string

ID of stock to edit

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

object (LibraryItemEntity)

Library item

vendor
string

Stock vendor name

Array of objects (GradeEntity)

List of grades specified for this stock

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "stock-type": {
    },
  • "vendor": "string",
  • "grades": [
    ]
}

Delete stock Deprecated

path Parameters
stockid
required
string

ID of stock to delete

Responses

Response samples

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

Get list of all stocks Deprecated

Responses

Response samples

Content type
[
  • {
    }
]

Add new stock Deprecated

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

object (LibraryItemEntity)

Library item

vendor
string

Stock vendor name

Array of objects (GradeEntity)

List of grades specified for this stock

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "stock-type": {
    },
  • "vendor": "string",
  • "grades": [
    ]
}

Response samples

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

Get grade by ID Deprecated

path Parameters
gradeid
required
string

ID of grade to get

stockid
required
string

ID of stock

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "grade-display": "Weight",
  • "weight": 0.1,
  • "weight-units": "GSM",
  • "weight-type": "Text",
  • "caliper": "string",
  • "cost": 0.1,
  • "cost-units": "FromGrade",
  • "any-sheet-size": true,
  • "sheets": [
    ],
  • "rolls": [
    ]
}

Edit grade Deprecated

path Parameters
gradeid
required
string

ID of grade to edit

stockid
required
string

ID of stock

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

grade-display
string
Enum: "Weight" "Caliper" "Both"

Grade display

weight
required
number <double>

Grade weight value

weight-units
string
Enum: "GSM" "Lb"

Grade weight units

weight-type
string
Enum: "Text" "Book" "Bond" "Offset" "Cover" "Bristol" "Index" "Tag" "Card"

Grade weight type for pound (Lb) standard weights

caliper
required
string

Caliper value

cost
number <double>

Cost of grade

cost-units
string
Enum: "FromGrade" "PerSheet" "Per500Sheets" "Per1000Sheets" "PerLb" "Per500Lb" "Per1000Lb" "PerKg" "Per1000Kg" "PerFt2" "PerM2" "PerFt" "PerM" "PerMSF" "PerMSI"

Cost unit type of grade

any-sheet-size
boolean

When true, any sheet size that can fit on a given press is assumed available via a sheet converter, custom order, etc.

Array of objects (SheetEntity)

List of sheets specified for this grade

Array of objects (RollEntity)

List of rolls specified for this grade

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "grade-display": "Weight",
  • "weight": 0.1,
  • "weight-units": "GSM",
  • "weight-type": "Text",
  • "caliper": "string",
  • "cost": 0.1,
  • "cost-units": "FromGrade",
  • "any-sheet-size": true,
  • "sheets": [
    ],
  • "rolls": [
    ]
}

Delete grade in stock Deprecated

path Parameters
gradeid
required
string

ID of grade to delete

stockid
required
string

ID of stock

Responses

Response samples

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

Get list of all grades in the stock Deprecated

path Parameters
stockid
required
string

ID of stock

Responses

Response samples

Content type
[
  • {
    }
]

Add new grade to stock Deprecated

path Parameters
stockid
required
string

ID of stock

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

grade-display
string
Enum: "Weight" "Caliper" "Both"

Grade display

weight
required
number <double>

Grade weight value

weight-units
string
Enum: "GSM" "Lb"

Grade weight units

weight-type
string
Enum: "Text" "Book" "Bond" "Offset" "Cover" "Bristol" "Index" "Tag" "Card"

Grade weight type for pound (Lb) standard weights

caliper
required
string

Caliper value

cost
number <double>

Cost of grade

cost-units
string
Enum: "FromGrade" "PerSheet" "Per500Sheets" "Per1000Sheets" "PerLb" "Per500Lb" "Per1000Lb" "PerKg" "Per1000Kg" "PerFt2" "PerM2" "PerFt" "PerM" "PerMSF" "PerMSI"

Cost unit type of grade

any-sheet-size
boolean

When true, any sheet size that can fit on a given press is assumed available via a sheet converter, custom order, etc.

Array of objects (SheetEntity)

List of sheets specified for this grade

Array of objects (RollEntity)

List of rolls specified for this grade

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "grade-display": "Weight",
  • "weight": 0.1,
  • "weight-units": "GSM",
  • "weight-type": "Text",
  • "caliper": "string",
  • "cost": 0.1,
  • "cost-units": "FromGrade",
  • "any-sheet-size": true,
  • "sheets": [
    ],
  • "rolls": [
    ]
}

Response samples

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

Get roll by ID Deprecated

path Parameters
rollid
required
string

ID of roll to get

gradeid
required
string

ID of grade

stockid
required
string

ID of stock

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "stock-id": "string",
  • "grade-id": "string",
  • "width": "string",
  • "cost": 0.1,
  • "cost-units": "FromGrade",
  • "grain": "AlongRoll"
}

Edit roll Deprecated

path Parameters
rollid
required
string

ID of roll to edit

gradeid
required
string

ID of grade

stockid
required
string

ID of stock

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

stock-id
string

ID of the stock of this roll

grade-id
string

ID of the grade of this roll

width
required
string

Roll width

cost
number <double>

Cost of this roll when cost not defined from grade

cost-units
string
Enum: "FromGrade" "PerSheet" "Per500Sheets" "Per1000Sheets" "PerLb" "Per500Lb" "Per1000Lb" "PerKg" "Per1000Kg" "PerFt2" "PerM2" "PerFt" "PerM" "PerMSF" "PerMSI"

Cost unit type of this roll when not defined from grade

grain
string
Enum: "AlongRoll" "AcrossRoll" "None"

The grain of this roll. Grain defaults to AlongRoll when not specified.

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "stock-id": "string",
  • "grade-id": "string",
  • "width": "string",
  • "cost": 0.1,
  • "cost-units": "FromGrade",
  • "grain": "AlongRoll"
}

Delete roll in grade Deprecated

path Parameters
rollid
required
string

ID of roll to delete

gradeid
required
string

ID of grade

stockid
required
string

ID of stock

Responses

Response samples

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

Get list of all rolls in the grade Deprecated

path Parameters
gradeid
required
string

ID of grade

stockid
required
string

ID of stock

Responses

Response samples

Content type
[
  • {
    }
]

Add new roll to grade Deprecated

path Parameters
gradeid
required
string

ID of grade

stockid
required
string

ID of stock

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

stock-id
string

ID of the stock of this roll

grade-id
string

ID of the grade of this roll

width
required
string

Roll width

cost
number <double>

Cost of this roll when cost not defined from grade

cost-units
string
Enum: "FromGrade" "PerSheet" "Per500Sheets" "Per1000Sheets" "PerLb" "Per500Lb" "Per1000Lb" "PerKg" "Per1000Kg" "PerFt2" "PerM2" "PerFt" "PerM" "PerMSF" "PerMSI"

Cost unit type of this roll when not defined from grade

grain
string
Enum: "AlongRoll" "AcrossRoll" "None"

The grain of this roll. Grain defaults to AlongRoll when not specified.

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "stock-id": "string",
  • "grade-id": "string",
  • "width": "string",
  • "cost": 0.1,
  • "cost-units": "FromGrade",
  • "grain": "AlongRoll"
}

Response samples

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

Get sheet by ID Deprecated

path Parameters
sheetid
required
string

ID of sheet to get

gradeid
required
string

ID of grade

stockid
required
string

ID of stock

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "stock-id": "string",
  • "grade-id": "string",
  • "dimension1": "string",
  • "dimension2": "string",
  • "cost": 0.1,
  • "cost-units": "FromGrade",
  • "grain": "Long"
}

Edit sheet Deprecated

path Parameters
sheetid
required
string

ID of sheet to edit

gradeid
required
string

ID of grade

stockid
required
string

ID of stock

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

stock-id
string

ID of the stock of this sheet

grade-id
string

ID of the grade of this sheet

dimension1
required
string

First dimension of this sheet

dimension2
required
string

Second dimension of this sheet

cost
number <double>

Cost of this sheet when cost not defined from grade

cost-units
string
Enum: "FromGrade" "PerSheet" "Per500Sheets" "Per1000Sheets" "PerLb" "Per500Lb" "Per1000Lb" "PerKg" "Per1000Kg" "PerFt2" "PerM2" "PerFt" "PerM" "PerMSF" "PerMSI"

Cost unit type of this sheet when not defined from grade

grain
string
Enum: "Long" "Short" "None"

The grain of this sheet. Grain is inferred by dimension2 when not specified.

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "stock-id": "string",
  • "grade-id": "string",
  • "dimension1": "string",
  • "dimension2": "string",
  • "cost": 0.1,
  • "cost-units": "FromGrade",
  • "grain": "Long"
}

Delete sheet in grade Deprecated

path Parameters
sheetid
required
string

ID of sheet to delete

gradeid
required
string

ID of grade

stockid
required
string

ID of stock

Responses

Response samples

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

Get list of all sheets in the grade Deprecated

path Parameters
gradeid
required
string

ID of grade

stockid
required
string

ID of stock

Responses

Response samples

Content type
[
  • {
    }
]

Add new sheet to grade Deprecated

path Parameters
gradeid
required
string

ID of grade

stockid
required
string

ID of stock

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

stock-id
string

ID of the stock of this sheet

grade-id
string

ID of the grade of this sheet

dimension1
required
string

First dimension of this sheet

dimension2
required
string

Second dimension of this sheet

cost
number <double>

Cost of this sheet when cost not defined from grade

cost-units
string
Enum: "FromGrade" "PerSheet" "Per500Sheets" "Per1000Sheets" "PerLb" "Per500Lb" "Per1000Lb" "PerKg" "Per1000Kg" "PerFt2" "PerM2" "PerFt" "PerM" "PerMSF" "PerMSI"

Cost unit type of this sheet when not defined from grade

grain
string
Enum: "Long" "Short" "None"

The grain of this sheet. Grain is inferred by dimension2 when not specified.

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "stock-id": "string",
  • "grade-id": "string",
  • "dimension1": "string",
  • "dimension2": "string",
  • "cost": 0.1,
  • "cost-units": "FromGrade",
  • "grain": "Long"
}

Response samples

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

Get stock by ID

path Parameters
stockid
required
string

ID of stock to get

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "stock-type": {
    },
  • "vendor": "string",
  • "grades": [
    ],
  • "path": "string"
}

Edit stock

path Parameters
stockid
required
string

ID of stock to edit

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

object (reference)

Library reference

vendor
string

Stock vendor name

Array of objects (grade)

List of grades specified for this stock

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "stock-type": {
    },
  • "vendor": "string",
  • "grades": [
    ],
  • "path": "string",
  • "properties": [
    ]
}

Delete stock

path Parameters
stockid
required
string

ID of stock to delete

Responses

Response samples

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

Get list of all stocks

Responses

Response samples

Content type
[
  • {
    }
]

Add new stock

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

object (reference)

Library reference

vendor
string

Stock vendor name

Array of objects (grade)

List of grades specified for this stock

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "stock-type": {
    },
  • "vendor": "string",
  • "grades": [
    ],
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get template by ID

path Parameters
templateid
required
string

ID of template to get

query Parameters
thumb
boolean
Default: false

Include thumbnail image or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "path": "string",
  • "width": "string",
  • "height": "string",
  • "thumbnail": {
    }
}

Delete template

path Parameters
templateid
required
string

ID of template to delete

Responses

Response samples

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

Get list of all templates

query Parameters
thumb
boolean
Default: false

Include thumbnail image or not

thumb-width
integer <int32>
Default: 200

Thumbnail width in pixels

thumb-height
integer <int32>
Default: 200

Thumbnail height in pixels

Responses

Response samples

Content type
[
  • {
    }
]

Import new template

Request Body schema:
name
string

Name of template asset to create including folders if desired. If name is not specified, file name minus extension will be used as the name.

id
string

ID of asset to use. If not specified a unique ID will be generated.

external-id
string

Optional external ID of media item

description
string

Asset description

create-folder
boolean

Boolean controlling whether to create a folder when folder or parent folder(s) does not exist. By default non-existent folders are not created automatically.

path
required
string

Full path of template file to import

preset
string

Name of preset to use during import

import-die-designs
boolean

Whether or not to import individual die designs from this template into the Die Designs library

die-designs-folder
string

Optional folder in Die Designs library to import die designs from this template into. Ignored if import die designs is disabled and defaults to root folder if not set.

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "create-folder": true,
  • "path": "string",
  • "preset": "string",
  • "import-die-designs": true,
  • "die-designs-folder": "string"
}

Response samples

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

Get thing by ID

path Parameters
thingid
required
string

ID of thing to get

Responses

Response samples

Content type
Example
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "allow-pass-through": true,
  • "connections": [
    ],
  • "costing": {
    },
  • "capabilities": {
    },
  • "script": {
    },
  • "manufacturer": "string",
  • "enforce-feed-type": true,
  • "media-rules": {
    },
  • "placement": {
    },
  • "operation": {
    },
  • "front-units": {
    },
  • "single-pass-double-sided": true,
  • "back-units": {
    },
  • "double-sided-speed-reduction": "string",
  • "gripper": "string",
  • "sheetTurn": "Turn",
  • "type": "SheetFedDigitalPress",
  • "feed-type": "Roll",
  • "process-type": {
    },
  • "path": "string"
}

Edit thing

path Parameters
thingid
required
string

ID of thing to edit

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

allow-pass-through
boolean

Allow pass-through

Array of objects (connector)

Direct connections to other things

required
object (sfdp-costing)

Sheet-fed Digital Press Costing

required
object (press-capabilities)

Press Capabilities

object (reference)

Library reference

manufacturer
required
string

Manufacturer

enforce-feed-type
boolean

When enabled, ensures that Imposition AI will only use rolls or sheets as dictated by whether this device's feed type is roll-fed or sheet-fed

required
object (press-media-rules)

Press media rules

required
object (press-placement)

Press Placement

required
object (operation-modes)

Operation Modes

required
object (press-units)

Press Units

single-pass-double-sided
boolean

Single Pass Double Sided

object (press-units)

Press Units

double-sided-speed-reduction
string

Double Sided Speed Reduction

gripper
string

Gripper

sheetTurn
required
string
Enum: "Turn" "Tumble"
type
required
string
feed-type
required
string
Enum: "Roll" "Sheet"
required
object (process-type)

Process Type

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
Example
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "allow-pass-through": true,
  • "connections": [
    ],
  • "costing": {
    },
  • "capabilities": {
    },
  • "script": {
    },
  • "manufacturer": "string",
  • "enforce-feed-type": true,
  • "media-rules": {
    },
  • "placement": {
    },
  • "operation": {
    },
  • "front-units": {
    },
  • "single-pass-double-sided": true,
  • "back-units": {
    },
  • "double-sided-speed-reduction": "string",
  • "gripper": "string",
  • "sheetTurn": "Turn",
  • "type": "SheetFedDigitalPress",
  • "feed-type": "Roll",
  • "process-type": {
    },
  • "path": "string",
  • "properties": [
    ]
}

Delete thing

path Parameters
thingid
required
string

ID of thing to delete

Responses

Response samples

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

Get list of all things

Responses

Response samples

Content type
[
  • {
    }
]

Add new thing

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

external-id
string

External ID

allow-pass-through
boolean

Allow pass-through

Array of objects (connector)

Direct connections to other things

required
object (sfdp-costing)

Sheet-fed Digital Press Costing

required
object (press-capabilities)

Press Capabilities

object (reference)

Library reference

manufacturer
required
string

Manufacturer

enforce-feed-type
boolean

When enabled, ensures that Imposition AI will only use rolls or sheets as dictated by whether this device's feed type is roll-fed or sheet-fed

required
object (press-media-rules)

Press media rules

required
object (press-placement)

Press Placement

required
object (operation-modes)

Operation Modes

required
object (press-units)

Press Units

single-pass-double-sided
boolean

Single Pass Double Sided

object (press-units)

Press Units

double-sided-speed-reduction
string

Double Sided Speed Reduction

gripper
string

Gripper

sheetTurn
required
string
Enum: "Turn" "Tumble"
type
required
string
feed-type
required
string
Enum: "Roll" "Sheet"
required
object (process-type)

Process Type

path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
Example
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "external-id": "string",
  • "allow-pass-through": true,
  • "connections": [
    ],
  • "costing": {
    },
  • "capabilities": {
    },
  • "script": {
    },
  • "manufacturer": "string",
  • "enforce-feed-type": true,
  • "media-rules": {
    },
  • "placement": {
    },
  • "operation": {
    },
  • "front-units": {
    },
  • "single-pass-double-sided": true,
  • "back-units": {
    },
  • "double-sided-speed-reduction": "string",
  • "gripper": "string",
  • "sheetTurn": "Turn",
  • "type": "SheetFedDigitalPress",
  • "feed-type": "Roll",
  • "process-type": {
    },
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Get tiling by ID

path Parameters
tilingid
required
string

ID of tiling to get

Responses

Response samples

Content type
Example
{
  • "id": "string",
  • "name": "string",
  • "created-on": "2019-08-24T14:15:22Z",
  • "modified-on": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "description": "string",
  • "notes": "string",
  • "start": "TopLeft",
  • "order": "SnakingVertical",
  • "horizontal-rule": {
    },
  • "horizontal-method": {
    },
  • "vertical-rule": {
    },
  • "vertical-method": {
    },
  • "type": "StandardTiling",
  • "path": "string"
}

Edit tiling

path Parameters
tilingid
required
string

ID of tiling to edit

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

start
string
Enum: "TopLeft" "TopRight" "BottomLeft" "BottomRight"
order
string
Enum: "SnakingVertical" "SnakingHorizontal" "ZigzagVertical" "ZigzagHorizontal"
object (tiling-rule)

Tiling rule

object (tiling-method)

Tiling method

object (tiling-rule)

Tiling rule

object (tiling-method)

Tiling method

type
required
string
path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
Example
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "start": "TopLeft",
  • "order": "SnakingVertical",
  • "horizontal-rule": {
    },
  • "horizontal-method": {
    },
  • "vertical-rule": {
    },
  • "vertical-method": {
    },
  • "type": "StandardTiling",
  • "path": "string",
  • "properties": [
    ]
}

Delete tiling

path Parameters
tilingid
required
string

ID of tiling to delete

Responses

Response samples

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

Get list of all tilings

Responses

Response samples

Content type
[
  • {
    }
]

Add new tiling

Request Body schema:
name
required
string

Name

description
string

Description

notes
string

Notes

start
string
Enum: "TopLeft" "TopRight" "BottomLeft" "BottomRight"
order
string
Enum: "SnakingVertical" "SnakingHorizontal" "ZigzagVertical" "ZigzagHorizontal"
object (tiling-rule)

Tiling rule

object (tiling-method)

Tiling method

object (tiling-rule)

Tiling rule

object (tiling-method)

Tiling method

type
required
string
path
string

Path

Array of objects (propertyObject)

Custom properties

Responses

Request samples

Content type
Example
{
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "start": "TopLeft",
  • "order": "SnakingVertical",
  • "horizontal-rule": {
    },
  • "horizontal-method": {
    },
  • "vertical-rule": {
    },
  • "vertical-method": {
    },
  • "type": "StandardTiling",
  • "path": "string",
  • "properties": [
    ]
}

Response samples

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

Presets API

Presets management

List all dynamic ink mapping presets

Responses

Response samples

Content type
[
  • {
    }
]

List all dynamic keyword mapping presets

Responses

Response samples

Content type
[
  • {
    }
]

List all Cover Sheet export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all CSV Report Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all cutting CFF2 export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all cutting DXF export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all cutting PDF export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all cutting ZCC export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all HP JDF export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all JDF export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all JDF export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all JSON Project Report Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all Kongsberg JDF export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all PDF export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all PDF Project Report Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all PDF Vector export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all tiling report export presets

Responses

Response samples

Content type
[
  • {
    }
]

List all XML Project Report Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all Ganging Profiles (Deprecated) Deprecated

Responses

Response samples

Content type
[
  • {
    }
]

List all ARD Die Import Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all CFF2 Die Layout Import Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all DDES2 Die Layout Import Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all DDES3 Die Layout Import Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all DXF Die Layout Import Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all MFG Die Import Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all PDF Die Layout Import Presets

Responses

Response samples

Content type
[
  • {
    }
]

List all Product CSV import presets

Responses

Response samples

Content type
[
  • {
    }
]

Get Imposition AI profile by ID

path Parameters
profile-id
required
string

ID of Imposition AI profile to get

Responses

Response samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "strategies": {
    },
  • "strip-options": {
    },
  • "layout-options": {
    },
  • "plan-options": {
    },
  • "web-options": {
    },
  • "applying-options": {
    },
  • "plan-rules": {
    },
  • "scripts": [
    ]
}

Edit Imposition AI profile

path Parameters
profile-id
required
string

ID of Imposition AI profile to edit

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

object (StrategiesEntity)

Setting to specify which layout strategies are used

object (StripOptionsEntity)

Settings used for vertical/horizontal/template strategies

object (LayoutOptionsEntity)

Settings used for creating each layout

object (PlanOptionsEntity)

Settings used for plans

object (WebOptionsEntity)

Settings used for web-based plans

object (ApplyingResultsEntity)

Actions to apply after Imposition AI results are applied to the job

object (RuleGroupEntity)

Group of rules

Array of objects (LibraryItemEntity)

Scripts

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "strategies": {
    },
  • "strip-options": {
    },
  • "layout-options": {
    },
  • "plan-options": {
    },
  • "web-options": {
    },
  • "applying-options": {
    },
  • "plan-rules": {
    },
  • "scripts": [
    ]
}

Delete Imposition AI profile

path Parameters
profile-id
required
string

ID of Imposition AI profile to delete

Responses

Response samples

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

Get list of all Imposition AI profile

Responses

Response samples

Content type
[
  • {
    }
]

Add new Imposition AI profile

Request Body schema:
name
required
string

Name of library item

id
string

Unique ID of this item (auto-generated, read-only)

external-id
string

Optional external ID of media item

description
string

Asset description

object (StrategiesEntity)

Setting to specify which layout strategies are used

object (StripOptionsEntity)

Settings used for vertical/horizontal/template strategies

object (LayoutOptionsEntity)

Settings used for creating each layout

object (PlanOptionsEntity)

Settings used for plans

object (WebOptionsEntity)

Settings used for web-based plans

object (ApplyingResultsEntity)

Actions to apply after Imposition AI results are applied to the job

object (RuleGroupEntity)

Group of rules

Array of objects (LibraryItemEntity)

Scripts

Responses

Request samples

Content type
{
  • "name": "string",
  • "id": "string",
  • "external-id": "string",
  • "description": "string",
  • "strategies": {
    },
  • "strip-options": {
    },
  • "layout-options": {
    },
  • "plan-options": {
    },
  • "web-options": {
    },
  • "applying-options": {
    },
  • "plan-rules": {
    },
  • "scripts": [
    ]
}

Response samples

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

List all Imposition AI Profiles (Deprecated) Deprecated

Responses

Response samples

Content type
[
  • {
    }
]

List all step-and-repeat presets

Responses

Response samples

Content type
[
  • {
    }
]

List all stock CSV presets

Responses

Response samples

Content type
[
  • {
    }
]

List all tiling presets

Responses

Response samples

Content type
[
  • {
    }
]