6.10 Print mode info

POST http://{{rip_ip}}:5438/devices/{{device_id}}/{{pmm_id}}/info/default

Gets the print mode definition like DPIs, bit-depth and ink-set from the print mode defined by PMM GUID (Print Mode GUID) and updated with the current user selected settings that are distilled from the UI script.

If “empty” is passed as PrintModeGUID the defaults are returned based on the user-settings provided. This is used when creating a PMM and thus the print mode has not been defined. The user-settings used for this query should thus be stored in the resulting PMM.

Appending the /default to the URL will return the print mode as defined in the PMM, ignoring any user made settings. Else the latest used user-settings will be applied.

Request

When empty and “empty” instead of a valid PrintModeGUID is passed then the driver defaults are returned.
When not empty and “empty” instead of a valid PrintModeGUID is passed then the user-settings are passed on resulting print-mode is returned.
If both user-settings are in the body and a valid PrintModeGUID is passed then only the settings that are marked as overridable in the UI script will be taken from the user-settings, the other settings are taken from the PMM.

Response

Object containing the details of the configuration of the printer for this print mode with the given user settings.

  • Name (string) : Name of the driver.
  • Group (string) : The Profile Group identifies the group of drivers this driver belongs too and with which profiles can be shared.
  • DID (integer) : Unique driver identifier, linked to the article code in the PrintFactory ordering system.
  • Width (number) : Maximum width of the device including margins expressed in PF-units (1/18th of an inch).
  • Height (number) : Maximum height or length of the material supported by the device including margins expressed in PF-units (1/18th of an inch).
  • Capabilities (object) : List of features the devices offers
    • Print (bool, optional) : This driver has printing capabilities
    • Cut (bool, optional) : This driver has (contour) cutting capabilities.
    • DTG (bool, optional) : This driver is a DTG printer.
    • Flatbed (bool, optional) : This device is a flatbed printer or plotter.
    • NeedUnimagedArea (bool, optional) : This device has no positioning capabilities and thus the x/y position in PageStart and RasterStart are ignored. This means that the RIP has to also image the non-imaged area in order to get correct positioning.
    • HighLevel (bool, optional) : This driver supports high level vector graphics expressed in real coordinates and supporting bezier curves.
    • AdditiveColors (bool, optional) : This driver (using the current settings) uses additive colors instead of subtractive inks (RGB).
    • EstimateInfo (bool, optional) : this driver supplies ink estimation and time estimation information. See Ink > Picoliters and SqUnitsPerHour.
    • DoubleSided (bool, optional) : This device has double sided printing capabilities with automatic loading of the B-side after the A-side has been printed.
    • BSideAsLayer (bool, optional) : This device has double sided printing capabilities with automatic placing the B-side as a layer in the same print size A-side has been printed. Where the B-side is placed as first layer and A-side as second layer. The B-side is expected to be delivered mirrored so it is readable from the reverse side of the print.
    • PreviewAtStart (bool, optional) : This driver requires a preview in the job XML before JobStart is called.
    • Console (bool, optional) : This device has a DFE and jobs will first appear there and require a printer operator to print the job.
    • RIPOnDemand (bool, optional) : This device supports RIP-on-demand whereby the RIP is called from the printer (as an action from the operator) to update the image data to match the changes on the DFE like rotation, crop or tonal corrections.
    • Registration (integer, optional) : Bit-flag indicating which types of registrations marks are supported by this device. Currently supported flags are:
      • Camera marks : (1 << 28)
      • Fotoba : (1 << 8)
      • Graphtec : (1 << 18)
      • HP cutter : (1 << 7)
      • Mimaki : (1 << 13)
      • Mimaki v0 : (1 << 24)
      • Mimaki v2 : (1 << 22)
      • Mimaki v3 : (1 << 27)
      • Mutoh EPOS : (1 << 6)
      • Roland GX : (1 << 26)
      • Roland RPOS : (1 << 12)
      • Summa OPOS : (1 << 5)
    • BarcodeScanner (bool, optional) : This device has a built-in barcode scanner for job recognition.
    • MediaQuery (bool, optional) : This device supports measuring of loaded media and optionally provides information on media type.
    • DeviceStatus (bool, optional) : This device supports feedback on device status. This might include loaded media size and type and ink levels.
    • StatusWhilePrinting (bool, optional) : This device is able to handle DeviceStatus calls during printing.
    • JobStatus (bool, optional) : This device supports status information based on the job its GUID.
    • ServiceUI (bool, optional) : This device provides a build HTML5 user-interface that can be presented inside the RIP or PrintStation.
  • Spectro (string, optional) : The type of photospectrometer that is built-in the device.
  • MarkerGUID (string, optional) : Filled when bit-flag “Camera marks” is set in Registration. This specifies the resource GUID (see 7. Resources) of the marker definition XML to be used as default for this device.
  • Resolution (object) : Information about the resolution of data expected for this print mode.
    • X (number, optional) : Horizontal (scanning) resolution expressed in dots-per-PF-unit (thus DPI/18).
    • Y (number, optional) : Vertical (feed) resolution expressed in dots-per-PF-unit (thus DPI/18).
    • Render (number, optional) : Render resolution expressed in dots-per-PF-unit (thus DPI/18). Note that the screening needs to occur at the X/Y resolution to avoid artefacts and jagged output.
    • Steps (number, optional) : Number of cutter plotter steps per PF-unit. Do note that at cutters the X-axis is the feed direction and the Y-axis is the scanning direction.
  • SqUnitPerHour (number, optional) : Amount of square units this device produces using the given settings. Used for calculating production estimated. Valid only when the estimateInfo flag is set.
  • InkType (string, optional) : The ink type used by the printer, empty when it is not a printer.
  • Inks (array, optional) : Inks used in this print mode and the order in which the data is expected.
    • Name (string) : Name of the ink
    • Type (string) : Type of ink channel. Valid values are:
      • Process : This ink is a process colour and should be used for building the full gamut.
      • Spot : This ink is a spot colour and is not used for building the full gamut.
      • Special : This ink is a technical ink like white, varnish or glue.
      • Duplicate : This ink is a duplicate of an earlier defined ink and should receive the same input data but a different screening seed to avoid interference.
    • DotCount (integer) : Number of dot levels for this channel. 1-bit devices have 2 levels (0 and 1), 2-bit devices can have 3 or 4 levels as 0 is also counted as an grey level. Valid values are all values from 2 to 16, 256, and 65536.
    • CIELab (array) : 3 numbers, representing CIELab L, a, b, used for previewing the output and colorizing the channel in composite views.
    • Screening (object) : Prefered screening for this channel.
      • Type (string) : Type of screening to be used. Valid values are: Error Diffusion, FM Screening, AM Screening, True Color, Floyd Steinberg, Chromatic Error Diffusion, Contone 16. True Color is the 8-bit contone variant.
      • BlueNoise (number, optional) : When using Error Diffusion, FM Screening or Floyd Steinberg this defines the amount of blue noise to introduce to define the randomness of the pattern.
      • MaxDot (number, optional) : When using Error Diffusion, FM Screening or Floyd Steinberg this defines the maximum percentage of small dots that is allowed to be used to avoid micro-banding.
      • Shape (string) : When using AM Screening the halftone shape to be used for this channel.
      • Angle (number) : When using AM Screening the angle to be used for this channel expressed in degrees.
      • Frequency (number) : When using AM Screening the lineature for this channel expressed in lines per inch.
    • DotSizes (array) : List of relative dot sizes for each level when DotCount is less than 256. The first value is assumed to be 0 and omitted. Usually the highest value is 1, but higher values are allowed to cap the maximum amount of the largest dot size.
    • Picoliters (array, optional) : List of dot sizes expressed in picoliter for each level when DotCount is less than 256. The first value is assumed to be 0 and omitted.
  • Settings (string, optional) : Settings as extracted from the UI script that resulted in this print mode.

Errors

  • 404 Not Found : {"Message":"Device not found"}
  • 404 Not Found : {"Message":"PMM not found"}

RESPONSES

status: OK

{&quot;Capabilities&quot;:{&quot;Console&quot;:true,&quot;Cut&quot;:true,&quot;Flatbed&quot;:true,&quot;HighLevel&quot;:true,&quot;Print&quot;:true,&quot;Registration&quot;:268435456},&quot;DID&quot;:1063,&quot;Group&quot;:&quot;PDF&quot;,&quot;Height&quot;:70866.140625,&quot;Inks&quot;:[{&quot;CIELab&quot;:[55,-37,-49],&quot;DotCount&quot;:256,&quot;Name&quot;:&quot;Cyan&quot;,&quot;Screening&quot;:{&quot;Type&quot;:&quot;True Color&quot;},&quot;Type&quot;:&quot;Process&quot;},{&quot;CIELab&quot;:[49,72,-5],&quot;DotCount&quot;:256,&quot;Name&quot;:&quot;Magenta&quot;,&quot;Screening&quot;:{&quot;Type&quot;:&quot;True Color&quot;},&quot;Type&quot;:&quot;Process&quot;},{&quot;CIELab&quot;:[89,-4,90],&quot;DotCount&quot;:256,&quot;Name&quot;:&quot;Yellow&quot;,&quot;Screening&quot;:{&quot;Type&quot;:&quot;True Color&quot;},&quot;Type&quot;:&quot;Process&quot;},{&quot;CIELab&quot;:[18,0,0],&quot;DotCount&quot;:256,&quot;Name&quot;:&quot;Black&quot;,&quot;Screening&quot;:{&quot;Type&quot;:&quot;True Color&quot;},&quot;Type&quot;:&quot;Process&quot;}],&quot;MarkerGUID&quot;:&quot;edc4afe0-4f33-4b3c-bb1d-10b894029c0e&quot;,&quot;Name&quot;:&quot;PDF CMYK XL&quot;,&quot;Resolution&quot;:{&quot;Render&quot;:33.33333206176758,&quot;Steps&quot;:1,&quot;X&quot;:33.33333206176758,&quot;Y&quot;:33.33333206176758},&quot;UI&quot;:&quot;\u003c?xml version=\&quot;1.0\&quot; encoding=\&quot;UTF-8\&quot; ?\u003e\r\u003cDriverSettings\u003e\r\t\u003cEDIT ID=\&quot;X_resolution\&quot; label=\&quot;X resolution:\&quot; minvalue=\&quot;50\&quot; maxvalue=\&quot;3600\&quot; changeable=\&quot;true\&quot; containerString=\&quot;DPI=$#\&quot;\u003e600\u003c/EDIT\u003e\r\t\u003cEDIT ID=\&quot;Y_resolution\&quot; label=\&quot;Y resolution:\&quot; minvalue=\&quot;50\&quot; maxvalue=\&quot;3600\&quot; changeable=\&quot;true\&quot; containerString=\&quot;,$# \&quot;\u003e600\u003c/EDIT\u003e\r\t\u003cPOPUP ID=\&quot;InkSet\&quot; label=\&quot;Ink set:\&quot; selected=\&quot;CMYK\&quot;\u003e\r\t\t\u003cITEM ID=\&quot;CMYK\&quot; label=\&quot;CMYK\&quot;\u003eINK=CMYK \u003c/ITEM\u003e\r\t\t\u003cITEM ID=\&quot;CMYKW\&quot; label=\&quot;CMYK+W\&quot;\u003eINK=CMYKW \u003c/ITEM\u003e\r\t\t\u003cITEM ID=\&quot;RGB\&quot; label=\&quot;RGB\&quot;\u003eINK=RGB \u003c/ITEM\u003e\r\t\u003c/POPUP\u003e\r\t\u003cPOPUP ID=\&quot;InkType\&quot; label=\&quot;Ink type:\&quot; selected=\&quot;UV\&quot;\u003e\r\t\t\u003cITEM ID=\&quot;Toner\&quot; label=\&quot;Toner\&quot;\u003eENCRE=Toner \u003c/ITEM\u003e\r\t\t\u003cITEM ID=\&quot;Dye\&quot; label=\&quot;Dye / Pigment\&quot;\u003eENCRE=Dye \u003c/ITEM\u003e\r\t\t\u003cITEM ID=\&quot;Solvent\&quot; label=\&quot;Solvent\&quot;\u003eENCRE=Solvent \u003c/ITEM\u003e\r\t\t\u003cITEM ID=\&quot;UV\&quot; label=\&quot;UV-curing\&quot;\u003eENCRE=UV \u003c/ITEM\u003e\r\t\t\u003cITEM ID=\&quot;Emulsion\&quot; label=\&quot;Emulsion\&quot;\u003eENCRE=Emulsion \u003c/ITEM\u003e\r\t\t\u003cITEM ID=\&quot;Sublimation\&quot; label=\&quot;Sublimation\&quot;\u003eENCRE=Sublimation \u003c/ITEM\u003e\r\t\t\u003cITEM ID=\&quot;Ceramics\&quot; label=\&quot;Ceramics\&quot;\u003eENCRE=Ceramics \u003c/ITEM\u003e\r\t\u003c/POPUP\u003e\r\t\u003cCHECKBOX ID=\&quot;MediaDir\&quot; label=\&quot;Media Sub-directory\&quot; selected=\&quot;Off\&quot; changeable=\&quot;true\&quot;\u003e\r\t\t\u003cCHECK ID=\&quot;Off\&quot; label=\&quot;Off\&quot;\u003eMEDIA=0 \u003c/CHECK\u003e\r\t\t\u003cCHECK ID=\&quot;On\&quot; label=\&quot;On\&quot;\u003eMEDIA=1 \u003c/CHECK\u003e\r\t\u003c/CHECKBOX\u003e\r\t\u003cCHECKBOX ID=\&quot;ModeDir\&quot; label=\&quot;Mode Sub-directory\&quot; selected=\&quot;Off\&quot; changeable=\&quot;true\&quot;\u003e\r\t\t\u003cCHECK ID=\&quot;Off\&quot; label=\&quot;Off\&quot;\u003eMODE=0 \u003c/CHECK\u003e\r\t\t\u003cCHECK ID=\&quot;On\&quot; label=\&quot;On\&quot;\u003eMODE=1 \u003c/CHECK\u003e\r\t\u003c/CHECKBOX\u003e\r\t\u003cCHECKBOX ID=\&quot;Timestamp\&quot; label=\&quot;Add Timestamp\&quot; selected=\&quot;On\&quot; changeable=\&quot;true\&quot;\u003e\r\t\t\u003cCHECK ID=\&quot;Off\&quot; label=\&quot;Off\&quot;\u003eSTAMP=0 \u003c/CHECK\u003e\r\t\t\u003cCHECK ID=\&quot;On\&quot; label=\&quot;On\&quot;\u003eSTAMP=1 \u003c/CHECK\u003e\r\t\u003c/CHECKBOX\u003e\r\t\u003cCHECKBOX ID=\&quot;Crop\&quot; label=\&quot;Crop page to print\&quot; selected=\&quot;On\&quot; changeable=\&quot;true\&quot;\u003e\r\t\t\u003cCHECK ID=\&quot;Off\&quot; label=\&quot;Off\&quot;\u003eCROP=0 \u003c/CHECK\u003e\r\t\t\u003cCHECK ID=\&quot;On\&quot; label=\&quot;On\&quot;\u003eCROP=1 \u003c/CHECK\u003e\r\t\u003c/CHECKBOX\u003e\r\t\u003cTOOLS ID=\&quot;Tool\&quot; label=\&quot;Tool: \&quot; selected=\&quot;CutContour\&quot;\u003e\r\t\t\u003cTOOL ID=\&quot;CutContour\&quot; label=\&quot;CutContour\&quot; color=\&quot;00ffff\&quot; /\u003e\r\t\u003c/TOOLS\u003e\r\u003c/DriverSettings\u003e\r&quot;,&quot;Width&quot;:3543.30712890625}