Returns a full list of all jobs - running jobs and completed jobs. Completed jobs will include jobs that processed successfully and any potential jobs that didn't complete because of errors.

The following properties are part of the response body:

Name	Type	Description
description	string	detailed description of the job
id	string	unique resource ID, generated by the server or supplied by user
name	string	short name of the job
progress	string	progress percentage for the job, 100% if job finished
status	string	responses include 'none', 'waitingForAccept', 'rejected', 'waiting', 'running', 'cancelling', 'cancelled', 'finished'
status-type	string	responses include 'none', 'info', 'warning', 'error', 'critical'

Starts a new job on the server for a specific input file.
ColorServer processes jobs using templates. There are three template types:

• Processing templates

• Normalization templates

• Color Conversion templates

A valid job requires at least a processing template. It is possible to reference the templates by either their ID or their name. Furthermore, different templates of each template type can be selected for image and vector processing.

Additional parameters

Additional parameters can be sent as part of the request body. Currently job-specific spot color rules and the desired output channels for dynamic conversion templates are supported.

Job-specific spot color rules

Job-specific spot color rules provide a flexible alternative to static spot color rules used in the color conversion template.
If rules are specified, all channel mapping rules used in the referenced conversion template are no longer taken into account.

The spot color rules are provided as an array of JSON objects in the request body, with each object containing the parameters for one spot color:

Parameter	Type	Description
colorName	string	Name of the spot color the rule refers to.
action	string	Rule to apply to the spot color. Possible values: none: Keeps the spot color unchanged. This option preserves the spot color but considers it during flattening. Use it if the spot color is part of the artwork and is not only used for overlaying technical objects. technicalChannel: Preserves the spot color and excludes objects using it from flattening. Use this option for technical spot colors such as dielines or varnish, which objects just overlay the artwork and do not have to be processed. remove: Removes the spot color from the file. This is helpful, for example, to remove technical objects such as dielines, that are not needed in further processing steps anymore. replace: Replaces the spot color with another spot color (see alias). This is helpful, for example, if a spot color in the file is not contained in the spot color database used in the conversion template, but the spot color database contains a similar color.
alias	string	In case of a replace rule, this is the name of the spot color that an existing spot color in the file is to be replaced with. In case of another action, the value has no relevance.

Example:

{
    "spotColorRules": [
        {
            "action": "none",
            "alias": "",
            "colorName": "White"
        },
        {
            "action": "technicalChannel",
            "alias": "",
            "colorName": "Cut"
        },
        {
            "action": "replace",
            "alias": "PANTONE Blue 072 C",
            "colorName": "Blue"
        },
        {
            "action": "remove",
            "alias": "",
            "colorName": "Dimensions"
        }
    ]
}

Job-specific layer rules

Job-specific layer rules provide a flexible alternative to static layer rules used in the PDF processing template.
If rules are specified, all layer rules used in the referenced PDF processing template are no longer taken into account.

The layer rules are provided as an array of JSON objects in the request body, with each object containing the parameters for one layer:

Parameter	Type	Description
layerType	string	Type of the layer. Possible values: custom: The rule applies to a regular layer which will be identified by the layerName. invisibleLayer: The rule applies to all layers with default visibility turned off. A layerName is not needed. processingStep: The rule applies to a processing step group or type as defined in ISO 19593-1, which will be identified by the layerName.
layerName	string	Name of the layer the rule refers to. If the layerType is processingStep, the value has to match the name of either a Processing Step Group or Type as defined in ISO 19593-1. Possible values: Structural Cutting PartialCutting ReversePartialCutting Creasing ReverseCreasing CuttingCreasing ReverseCuttingCreasing PartialCuttingCreasing ReversePartialCuttingCreasing Drilling Gluing FoilStamping ColdFoilStamping Embossing Debossing Perforating Bleed VarnishFree InkFree InkVarnishFree Folding Punching Stapling Dimensions Hologram Barcode ContentArea CodingMarking Imprinting Braille Legend Positions White Varnish
action	string	Rule to apply to the layer. Possible values: convert: Converts the layer. This is the default for any layer and in most cases it is not necessary to explicitely define this rule. However, in a PDF it is possible that multiple Optional Content Groups / layers are assigned to an object. In that case, ColorServer will apply the rule of the first layer in this layer rule set that is associated with the object. dontConvert: Preserves the spot layer and excludes objects using it from flattening and color management. Use this option for layers with technical spot colors such as dielines or varnish, especially if your workflow makes use of PDF Processing Steps. removeLayer: Removes the layer and its associated objects from the file.

Example:

{
    "layerRules": [
        {
            "layerType": "custom",
            "layerName": "Layer 1",
            "action": "convert"
        },
        {
            "layerType": "processingStep",
            "layerName": "FoilStamping",
            "action": "dontConvert"
        },
        {
            "layerType": "invisibleLayers",
            "action": "removeLayer"
        }
    ]
}

Dynamic Profiling: Output Channels

If the selected color conversion template uses dynamic processors which request conversion profiles from GMG OpenColor on the fly, it is possible to define the output channels of the profiles.
Please note that the output channels have to be a subset of the inks of the OpenColor output project.

Example:

{
    "outputChannels": [
        "Cyan",
        "Magenta",
        "Yellow"
    ]
}

Dynamic Profiling: Color Management Parameters

Furthermore, it is possible to overwrite all other Dynamic Profiling parameters for a job in
a dynamicProfilingParams JSON object.

Parameter	Type	Description
separationParams	object	Separation parameters. tac float Total Area Coverage. min: 1.8 (180%), max: 4 (400%) gcrLevel float GCR Level (CMYK). min: 0 (0%), max: 100 (100%) blackStart float Black Start (CMYK). min: 0 (0%), max: 100 (100%)
gamutMappingParams	object	Gamut Mapping parameters for process color conversion. grayAxisAlignment float Gray Adjustment to Target Media. min: 0 (0%), max: 100 (100%) blackPointCompensation float Black Point Compensation. min: 0 (0%), max: 100 (100%) gamutExpansion float Gamut Expansion. min: 0 (0%), max: 100 (100%)
purifyParams	object	Purify parameters for process color conversion. purifyBlack bool Keep Black pure. force100Black bool Keep 100% Black at 100%. useBlack bool Use Black in separations. purifyCMY string Keep CMY pure. Possible values: auto, enable, disable autoPurifyDeltaEThreshold float If PurifyCMY is set to auto, keep CMY pure if DeltaE is below this threshold. min: 0 allowAdditionalInksInOverprints bool Allow Additional Inks in Overprints.
spotColorSeparationParams	object	Separation parameters for spot color conversion. maximumNumberOfOutputInks int Max. Number of Inks per Separated Color. min: 1, max: 4 controlledInkReduction string Method for automatic reduction of output channels. Possible values: noInkReduction, lowestNumber, preferableCmyk controlledInkReductionThreshold float DeltaE threshold for automatic reduction of output channels. min: 0

Example:

{
    "dynamicProfilingParams": {
        "separationParams": {
            "tac": 3.0,
            "gcrLevel": 75.0,
            "blackStart": 10.0
        },
        "gamutMappingParams": {
            "grayAxisAlignment": 30.0,
            "blackPointCompensation": 100.0,
            "gamutExpansion": 20.0
        },
        "purifyParams": {
            "purifyBlack": true,
            "force100Black": true,
            "purifyCMY": "auto",
            "autoPurifyDeltaEThreshold": 1.0,
            "allowAdditionalInksInOverprints": false
        },
        "spotColorSeparationParams": {
            "maximumNumberOfOutputInks": 3,
            "controlledInkReduction": "lowestNumber",
            "controlledInkReductionThreshold": 2.0
        }
    }
}

Returns a list of clients that submitted jobs to the server. This includes the hotfolder service as well as deleted jobs.

Returns all ink saving report data available on the server.
The calculation of ink savings must however be enabled in a PDF template, and will be carried out only for jobs which are using such templates.
Additionally, for each job using a template with the activated ink saving option a separate ink saving report file will be generated and added to the job result file set. This file ID can be then extracted from the job result subresource and then the job specific report can be downloaded from the files repository.

Returns the status of a specific job.
The response includes the following properties:

Name	Type	Description
progress	float	Indicates the progress of the job. Ranges from 0 to 1.
status	string	Status of the job. Possible values are running, finished, canceled, rejected.
statusType	string	Type of the status. Possible values are info, warning, error, critical.

Cancels or resumes a job. There are no parameters, only a request JSON object with the key-value pair for status. Only accepts cancelled and waitingForAccept.

Returns meta information about a specific job.
The response includes the following properties:

Name	Type	Description
description	string	Detailed desription of the job.
id	UUID	Job's unique resource ID generated by the server or supplied by the user.
name	string	Name of the job generated by the server.
status	string	Path to the subresource. If using style=detailed, attributes are included directly.
result	string	Path to the subresource. If using style=detailed, attributes are included directly.
ticket	string	Path to the subresource. If using style=detailed, attributes are included directly.

Deletes a specific job and its associated files from the server.

Returns a complete job ticket for a specific job, which includes all parameters actually used when processing it. The response includes the following properties:

Name	type	Description
clientID	string	ID of the client which started the job.
jobCreator	string	Display name of the client which started the job.
inputField	UUID	ID of the input file.
clientFilePath	string	Storage path of the input file.
creationTime	RFC 1123 date	Time when the job arrived at the server.
jobParams	JSON	Template-specific parameters used with that job. Original template parameters OR template parameters with overrides applied will be included.
jobTemplateIDs	array	An array or list of the types of templates used with this job.
jobTemplateNames	array	An array of names of the templates used with this job.
jobTemplateTypes	array	An array of the template type IDs.
subTemplatesTag	array	An array of pairs of templateID and templateTypeID. Used to distinguish between vector and image templates.
jobTicketSupportedOperations	string	Contraints for this job ticket. Values include: deleteOnFinished - ticket has to be deleted after processing; createOutput - the associated job is expected to create output files. Primarily for internal use.
workerTypeID	string	Type of worker processing the job.
localeID	string	Locale used with the job.

Returns the result of a specific job.
The response includes the following properties:

Name	type	Description
outputFiles	array	Array holding the fileId for each file that resulted from the job processing.
outputFiles[i].fileId	string	ID of the output file. Usually, there is only one output file, so the first array entry refers to the processed file.
jobCreator	string	Display name of the client which started the job.
processingLog	obj	Object containing an array of all log messages.
startTime	RFC 1123 date	Time when the job was started.
finishedTime	RFC 1123 date	Time when the job was finished.

Returns a list of files on the server. Returns both inputs and results, physically on the server, including uploaded files and files known to the server by their path as linked files.
The response includes the following properties:

Name	Type	Description
description	string	Description of the file.
id	string	ID of the file.
linked	bool	Indicates if the file is not uploaded to the server but registered/linked.
name	string	The name of the file without file extension.
storagePath	string	The path to the file.

Registers a file with the server, meaning that it will not be stored on the server but its location is communicated to the server, so that it can be fetched from there once a job is started.

Uploads a file to the server. Header parameter content-type must be application/octet-stream.

Returns details of a specific file.
The response includes the following properties:

Name	Type	Description
description	string	Description of the file.
id	string	ID of the file.
linked	bool	Indicates if the file is not uploaded to the server but registered/linked.
name	string	The name of the file without file extension.
storagePath	string	The path to the file.

Deletes a file from the server.

Downloads a file from the server. Header parameter Accept must be set to application/octet-stream.
The response is the binary data of the file which can be stored as a file on the system afterwards.

Returns a list of all resources.
The response includes the following properties:

Name	Type	Description
href	string	Relative path to the resource.
locked	bool	Indicates if the resource is locked or can be edited.
name	string	The name of the resource.
type	string	The type of the resource.
updated	RFC 1123 date	The date the resource was last updated.