Fixups

1. List all available xml based Fixups

Compatibility: from Durst Workflow v1.7.6

Available in
Durst Workflow Print Label / Durst Workflow Print Label +
Durst Workflow Print /  Durst Workflow Print +

You can list all available XML based Fixups installed on the Durst Workflow (limited number of Fixups on non + Workflow Editions). The response lists the Fixups with their IDs, Names, a short description, and variables that can be used when applying a Fixup to an Article or Print Item.

GET /api/v1/fixups

1.1. Responses

HTTP Code Description Schema
200 OK FixupRequestOptionsApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

1.2. Consumes

application/json

1.3. Produces

*/*

1.4. Tags

Fixup Controller Api

1.5. Example HTTP request

Request path

/api/v1/fixups 

1.6. Example HTTP response

Response 200

[
  {
    "id": 22,
    "automationKey": "EXTRACT_COLORS_FROM_DEVICE-N",
    "name": "Extract Colors from DeviceN",
    "comment": "Converts objects created as DeviceN to the corresponding Separation Color Space by removing the DeviceN components and recreating the components in the Separation Color Space. Use this Fixup to extract DieLines in the PDF file from DeviceN constructs to make them editable.",
    "variables": [
      {
        "key": "DO_FIXUP_EXTRACT_SPOT_COLORS_FROM_DEVICE-N",
        "defaultValue": true,
        "valueType": "BOOLEAN",
        "options": []
      },
      {
        "key": "DO_FIXUP_EXTRACT_CMYK_COLORS_FROM_DEVICE-N",
        "defaultValue": false,
        "valueType": "BOOLEAN",
        "options": []
      },
      {
        "key": "DO_FIXUP_EXTRACT_ALL_COLORS_FROM_DEVICE-N",
        "defaultValue": false,
        "valueType": "BOOLEAN",
        "options": []
      }
    ]
  },
  {
    "id": 83,
    "automationKey": "ROTATE_AND_MIRROR_PAGE",
    "name": "Rotate and/or mirror page",
    "comment": "Rotates a page 90° clockwise, 90° counterclockwise or 180° and/or mirrors a page horizontally or vertically.",
    "variables": [
      {
        "key": "VAR_NAME_Rotate",
        "valueType": "STRING",
        "options": [
          "180",
          "270",
          "90",
          "ApplyPageRotateOnly"
        ]
      },
      {
        "key": "VAR_NAME_Flip",
        "valueType": "STRING",
        "options": [
          "Horizontally",
          "Vertically"
        ]
      }
    ]
  }
]
2. List details of a specific Fixup by ID

Compatibility: from Durst Workflow v1.7.6

Available in
Durst Workflow Print Label / Durst Workflow Print Label +
Durst Workflow Print /  Durst Workflow Print +

Get information for a specific Fixup using its ID.

GET /api/v1/fixups/{id}

2.1. Parameters

Type
Name
Description
Schema
Path
id required
The id of a Fixup
integer (int32)

2.2. Responses

HTTP Code Description Schema
200 OK FixupRequestOptionsApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

2.3. Consumes

application/json

2.4. Produces

*/*

2.5. Tags

Fixup Controller Api

2.6. Example HTTP request

Request path

/api/v1/fixups/{id}

2.7. Example HTTP response

Response 200

{
  "id": 82,
  "automationKey": "ROTATE_PAGE",
  "name": "Rotate page",
  "comment": "Rotates pages 90° clockwise, 90° counterclockwise or 180°.",
  "variables": [
    {
      "key": "VAR_NAME_Rotate",
      "defaultValue": "ApplyPageRotateOnly",
      "valueType": "STRING",
      "options": [
        "ApplyPageRotateOnly",
        "90",
        "180",
        "270"
      ]
    }
  ]
}
3. Apply a Fixup to a Motif within a Print Order or Production Job

Compatibility: from Durst Workflow v1.7.6

Available in
Durst Workflow Print Label / Durst Workflow Print Label +
Durst Workflow Print /  Durst Workflow Print +  

Apply an XML based Fixup to a Motif/Print Item within a Print Order or Production Job. The ID of the Motif can be extracted from the response of the calls GET /api/v1/printOrders/{id} and GET /api/v1/productionJobs/{id}. See Create Print Order and Create Production Job for details.

POST /api/v1/motifs/{id}/applyFixup

3.1. Parameters

Type
Name
Description
Schema
Path
id required
The id of a Motif
integer (int32)
Body  FixupRequestOptionsApi required
Parameters of the Fixup FixupRequestOptionsApi
Body 
ReferencedFixupApi optional
Name or ID of the Fixup ReferencedFixupApi

3.2. Responses

HTTP Code Description Schema
200 OK FixupRequestOptionsApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

3.3. Consumes

application/json

3.4. Produces

*/*

3.5. Tags

Fixup Controller Api

3.6. Example HTTP request

Request path

api/v1/motifs/{id}/applyFixup

Request Body

{
  "fixupApiParameter": {
    "VAR_NAME_Rotate": "90",
    "VAR_NAME_Flip": "Horizontally"
  },
  "fixupApiReference": {
    "automationKey": "ROTATE_AND_MIRROR_PAGE",
    "id": 83
  }
}

3.7. Example HTTP response

The response contains the id for the Workflow. This is the internal naming convention of the running process. As the Fixup process may take some time, the status of this running process can be checked with GET /api/v1/workflows/{id}.

Response 200

{
  "id": 5477,
  "name": "motif-apply-profile",
  "progress": 0,
  "status": "RUNNING",
  "currentStep": "preFlight",
  "startTimestamp": "2019-09-12T13:21:19.395",
  "executionTime": 0
}
4. Fixup Examples

Compatibility: from Durst Workflow v1.7.6

Available in
Durst Workflow Print Label / Durst Workflow Print Label +
Durst Workflow Print /  Durst Workflow Print +

These are some examples how Fixup Parameters and Attributes are used. Almost every Fixup from the Durst Workflow with a XML Translation can be used for a API Request to be applied on a Article or a Print ITem (Motif).

4.1. Rotate

Request Body

{
  "fixupApiReference": {
    "automationKey": "ROTATE_PAGE"
  },
  "fixupApiParameter": {
    "VAR_NAME_Rotate": "90"
  }
}

Rotate the Item by 90 degrees

4.2. Bleed by Mirroring

Request Body

{
  "fixupApiReference": {
    "automationKey": "CREATE_BLEED_MIRRORING"
  },
  "fixupApiParameter": {
    "VAR_NAME_Create_bleed_mirror": "3",
    "VAR_NAME_Unit": "mm",
    "VAR_NAME_Resolution_rendering": "400",
    "VAR_NAME_Mirror_method": "LastPixel",
    "VAR_NAME_Spot_Color_Regex": true,
    "VAR_NAME_Bleed_Behind_Content": false,
    "VAR_NAME_Left_edge": false,
    "VAR_NAME_Right_edge": true,
    "VAR_NAME_Bottom_edge": true,
    "VAR_NAME_Top_edge": true
  }
}

Create a 3 mm bleed by Mirroring. Use the Last Pixel and Apply the Bleed to Right, Bottom and Top. Do not create Bleed behind existing page content.

4.3. Convert Pure Black to Rich Black

Request Body

{
  "fixupApiReference": {
    "automationKey": "CONVERT_PURE_BLACK_TO_RICH_BLACK"
  },
  "fixupApiParameter": {
    "VAR_NAME_FilterByObjecttype": "None",
    "VAR_NAME_Target_cyan": "20",
    "VAR_NAME_Target_magenta": "20",
    "VAR_NAME_Target_yellow": "20",
    "VAR_NAME_Target_black": "100",
    "VAR_NAME_INTERMEDIATE_VALUES": true
  }
}

Convert all Black Objects to 20/20/20/100 CMYK. Also include intermediate color values