2022.2

PAGE 161

var file = $("#datamapper")[0].files[0], named = $("#named").prop("checked"), persistent = $("#persistent").prop("checked"); var settings = { type: "POST", url: "/rest/serverengine/filestore/DataMiningConfig?persistent=" + persistent, data: file, processData: false, contentType: "application/octet-stream" }; if (named) settings.url += "&filename=" + file.name; $.ajax(settings) .done(function (response) { c.displayStatus("Request Successful"); c.displayInfo("Data Mapping Configuration '" + file.

PAGE 162

Screenshot & Output Usage To run the example simply select the Browse button and then select the data mapping configuration you wish to upload using the selection dialog box.

PAGE 163

uploaded file will be associated with (or can be referenced using) that name. Once the configuration and options are selected, simply select the Submit button to upload the configuration to the server's file store and the resulting Managed File ID for the data mapping configuration will be returned and displayed to the Results area. Discussion Firstly, we define an event handler that will run in response to the submission of the HTML form via the selection of the Submit button.

PAGE 164

When the request is successful or done, a request response is received and the content of that response is passed as the function parameter response. In the example, we then display the value of this parameter which should be the new Managed File ID of the data mapping configuration in the file store. Further Reading See the File Store Service page of the REST API Reference section for further detail.

PAGE 165

Uploading a Template to the File Store Problem You want to upload a template to the File Store so that it can be used as part of a Content Creation operation. Solution The solution is to create a request using the following URI and method type to submit the template to the server via the File Store REST service: Upload Template /rest/serverengine/filestore/template POST Example HTML5 fs-template-upload.

PAGE 166

Options

PAGE 167

var settings = { type: "POST", url: "/rest/serverengine/filestore/template?persistent=" + persistent, data: file, processData: false, contentType: "application/zip" }; if (named) settings.url += "&filename=" + file.name; $.ajax(settings) .done(function (response) { c.displayStatus("Request Successful"); c.displayInfo("Template '" + file.name + "' Uploaded Successfully"); c.displayResult("Managed File ID", response); }) .fail(c.

PAGE 168

Usage To run the example simply select the Browse button and then select the template you wish to upload using the selection dialog box. Next you can specify the following options to use with the upload of the template: l l Named – allow this template to be identified/referenced by its Managed File Name as well as its Managed File ID Persistent – make this template persistent in the file store Note Only one Managed File in the file store can be associated with a specific name.

PAGE 169

Method type and url arguments are specified as shown earlier, with the addition of a persistent query parameter which specifies whether the template is to be persistent in the file store when uploaded. We specify the variable file as the data or contents of the request, a contentType argument of "application/zip", and because we are sending file data we also specify a processData argument set to false.

PAGE 170

Uploading a Job Creation Preset to the File Store Problem You want to upload a job creation preset to the File Store so that it can be used as part of a Job Creation operation. Solution The solution is to create a request using the following URI and method type to submit the job creation preset to the server via the File Store REST service: Upload Job Creation Preset /rest/serverengine/filestore/JobCreationConfig POST Example HTML5 fs-jcpreset-upload.

PAGE 171

PAGE 172

named = $("#named").prop("checked"), persistent = $("#persistent").prop("checked"); var settings = { type: "POST", url: "/rest/serverengine/filestore/JobCreationConfig?persistent=" + persistent, data: file, processData: false, contentType: "application/xml" }; if (named) settings.url += "&filename=" + file.name; $.ajax(settings) .done(function (response) { c.displayStatus("Request Successful"); c.displayInfo("Job Creation Preset '" + file.name + "' Uploaded Successfully"); c.

PAGE 173

Screenshot & Output Usage To run the example simply select the Browse button and then select the job creation preset you wish to upload using the selection dialog box.

PAGE 174

Once the preset and options are selected, simply select the Submit button to upload the preset to the server's file store and the resulting Managed File ID for the job creation preset will be returned and displayed to the Results area. Discussion Firstly, we define an event handler that will run in response to the submission of the HTML form via the selection of the Submit button. When our event handler function is called, we then obtain a reference to the local job creation preset previously selected.

PAGE 175

Further Reading See the File Store Service page of the REST API Reference section for further detail.

PAGE 176

Uploading an Output Creation Preset to the File Store Problem You want to upload an output creation preset to the File Store so that it can be used as part of a Output Creation operation. Solution The solution is to create a request using the following URI and method type to submit the output creation preset to the server via the File Store REST service: Upload Output Creation Preset /rest/serverengine/filestore/OutputCreationConfig POST Example HTML5 fs-ocpreset-upload.

PAGE 177

PAGE 178

named = $("#named").prop("checked"), persistent = $("#persistent").prop("checked"); var settings = { type: "POST", url: "/rest/serverengine/filestore/OutputCreationConfig?persistent=" + persistent, data: file, processData: false, contentType: "application/xml" }; if (named) settings.url += "&filename=" + file.name; $.ajax(settings) .done(function (response) { c.displayStatus("Request Successful"); c.displayInfo("Output Creation Preset '" + file.name + "' Uploaded Successfully"); c.

PAGE 179

Screenshot & Output Usage To run the example simply select the Browse button and then select the output creation preset you wish to upload using the selection dialog box.

PAGE 180

Once the preset and options are selected, simply select the Submit button to upload the preset to the server's file store and the resulting Managed File ID for the output creation preset will be returned and displayed to the Results area. Discussion Firstly, we define an event handler that will run in response to the submission of the HTML form via the selection of the Submit button.

PAGE 181

Further Reading See the File Store Service page of the REST API Reference section for further detail.

PAGE 182

Working with the Entity Services This section consists of a number of pages covering various useful working examples: 1. Finding Specific Data Entities in the Server 2. Finding all the Data Sets in the Server 3. Finding the Data Records in a Data Set 4. Finding all the Content Sets in the Server 5. Finding the Content Items in a Content Set 6. Finding all the Job Sets in the Server 7.

PAGE 183

Finding Specific Data Entities in the Server Problem You want to find specific Data Entities stored within the PlanetPress Connect Server based on a set of search criteria. Solution The solution is to create a request using the following URI and method type and submit it to the server via the Entity REST service: Find Data Entity /rest/serverengine/entity/find PUT Example HTML5 e-find-data-entity.

PAGE 184

Data Sets Content Items Content Sets Jobs Job Sets

PAGE 185

PAGE 186

PAGE 187

data-type="enum-condition-string"/>

PAGE 188

PAGE 191

PAGE 195

PAGE 201

incompatible = {}, reconfigure = {}; categories.forEach(function (category) { options[category] = []; $("fieldset#" + category) .find("#rule-type") .children("option") .each(function (index, option) { var $option = $(option), allClazz = $entity.attr("id") + ""; if ($option.hasClass(allClazz) || $option.hasClass(allClazz + $entity.val())) options[category].push($option.val ()); }); }); /** * Prompt User & Remove any Existing Rules that are * incompatible with currently Entity type selected */ categories.

PAGE 202

var type = $entity.attr ("id") + "-" + entity; if ($(rule).find ("div.option").hasClass(type)) { if (reconfigure [category] === undefined) reconfigure [category] = []; reconfigure [category].push(index); } }); }); }); if (Object.keys(incompatible).length > 0 && !confirm(MSG_INCOMPAT_RULES)) { $entity.val($entity.data("previous")); return; } categories.forEach(function (category) { var $rules = $("fieldset#" + category) .children("div#RULESET") .find("div.

PAGE 203

var $selector = $("fieldset#" + category).find ("#rule-type"), selection = $selector.val(); $selector .children() .each(function (index, option) { var $option = $(option), name = $option.val(), invalid = ($.inArray(name, options [category]) < 0); if (invalid && selection === name) selection = null; $option .prop("disabled", invalid) .prop("hidden", invalid); }) .each(function (index, option) { var $option = $(option); if (selection === null && !$option.prop ("disabled")) { $selector.val($option.

PAGE 204

if ($body.find("div:visible #compareType").val () === "name") fieldType = "FIELD"; else if ($body.find("div #fieldType").val() === "date") fieldType = "DATE"; $body .children("div") .not(".form-only") .children(":visible :input") .each(function (index, input) { var $input = $(input), id = $input.attr("id"), type = $input.attr("type"), value; if (id !== undefined && !$input.prop("disabled")) { if (id.match(/^value(s|\d*)\-/) !== null) { type = id.split("-")[1]; id = id.

PAGE 205

} if (fieldType !== null && id.match(/^value\d*$/)) value = { "type": fieldType, "value": value }; rule[id] = value; } }); if (ruleType === "RULESET") rule.rules = processRules($body.children ("div.sub-rules")); rules.push($.extend(true, { [typeKey]: ruleType }, rule)); }); return rules; } $("form") /* Add Rule Handler */ .on("click", "input#add-rule", function (event) { var $parent = $(event.target).closest("fieldset"), $rule = loadRule($parent.attr("id"), $parent .find ("#rule-type") .val ()); $(event.

PAGE 206

/* Remove Rule Handler */ .on("click", "input#remove-rule", function (event) { var $rule = $(event.target).closest(".rule"), remove = true; if ($rule.attr("id") === "RULESET" && $rule.find("div.sub-rules div.rule").length > 1) if (!confirm(MSG_MULTIPLE_RULES)) remove = false; if (remove) $rule.remove(); }) /* "Select Rule Options" Change Handler */ .on("change", "select.options-selector", function (event) { var $entity = $("#entity"), types = $entity .children("option") .toArray() .

PAGE 207

if ($option.hasClass(clazz)) matched.push(clazz); }); if (matched.length) selected = ($.inArray($entity.attr ("id") + "-" + $entity.val(), matched) >= 0); $selectors.each(function (selectorIndex, selector) { var allClass = selector.id + "-"; if (!$option.hasClass(allClass) && !$option.hasClass(allClass + $(selector).val())) { selected = false; } }); $option .prop("hidden", !selected) .find("input, select") .prop("disabled", !selected); if (before && selected) unhidden.push($option .children("select.

PAGE 208

"search": processRules(($("#search")))[0], }; /* Process & Add Sorting & Grouping Rules */ ["sort", "group"].forEach(function (type) { var rules = (processRules($("#" + type +"ing")))[0].rules; if (rules.length) search[type] = rules; }); $.ajax({ type: "PUT", url: "/rest/serverengine/entity/find", data: JSON.stringify(search), contentType: "application/json" }) .done(function (response) { c.displayStatus("Request Successful"); c.displayHeading("Input Parameters"); c.

PAGE 209

Screenshot & Output Page 209

PAGE 210

Page 210

PAGE 211

Usage To run the example first select the Entity Type that you are searching for. The data entity types available are: l Data Sets l Data Records l Content Sets l Content Items l Job Sets l Jobs Once a data entity type is selected, various rules can be added to form the search criteria. There are three categories of rules available: search, sorting and grouping rules.

PAGE 212

The types of search rules available are specific to the data entity type selected.

PAGE 213

Data Value search rules can be configured by specifying the following options: l l l Name – Name of the data record field to search by Condition – Operator for the comparison of the data record field (e.g. Equals (=), Not Equals (<>), Less Than (<), Greater Than (>), etc.

PAGE 214

l l Binding Style – The style of binding to match (e.g. Stapled, Glued, Stitched, Coil, etc.) Binding Edge – The edge (or side on which the binding occurs) to match (e.g. Left, Right, Top or Bottom) l Binding Type – The type or location of the binding to match (e.g. Saddle, Side or Corner) l Binding Angle – The binding angle to match (e.g.

PAGE 215

Sorting Rules There are also two types of sorting rules that can be used as part of the overall search criteria: l Data Value – Sort the search results by the value of a data record field l Property Value – Sort the search results by the value of a data entity property The types of sorting rules available are also specific to the data entity type selected.

PAGE 216

Grouping Rules There are also two types of grouping rules that can be used as part of the overall search criteria: l Data Value – Group the search results by the value of a data record field l Property Value – Group the search results by the value of a data entity property The types of grouping rules available are also specific to the data entity type selected.

PAGE 217

Note By default, comparison conditions in search rules are evaluated alphanumerically, regardless of the type of value. Numeric evaluation of comparison conditions is not currently supported in the PlanetPress Connect REST API. The only exception to this rule is the ability to numerically sort or group results by specifying sorting or grouping rules of a Data Value type. Warning The Entity Type selected for the search criteria can be changed during or even after rules have been added.

PAGE 218

Finding all the Data Sets in the Server Problem You want to obtain a list of all the previously created Data Sets contained in the PlanetPress Connect Server potentially for use in a Content Creation operation. Solution The solution is to create a request using the following URI and method type and submit it to the server via the Data Set Entity REST service: Get All Data Sets /rest/serverengine/entity/datasets GET Example HTML5 dse-get-all-datasets.

PAGE 219

JavaScript/jQuery dse-get-all-datasets.js /* Data Set Entity Service - Get All Data Sets Example */ (function ($, c) { "use strict"; $(function () { c.setupExample(); $("form").on("submit", function (event) { event.preventDefault(); if (!c.checkSessionValid()) return; $.ajax({ type: "GET", url: "/rest/serverengine/entity/datasets" }) .done(function (response) { c.displayStatus("Request Successful"); c.displayHeading("Data Set IDs"); c.displaySubResult("Plain", c.

PAGE 220

Screenshot & Output Usage To run the example simply select the Submit button to request a list of the all the data sets currently contained within the server. The resulting list will then be returned and displayed to the Results area in both Plain list and JSON Identifier List formats. Further Reading See the Data Set Entity Service page of the REST API Reference section for further detail.

PAGE 221

Finding the Data Records in a Data Set Problem You want to obtain a list of all the previously created Data Records contained within a specific Data Set potentially for use in a Content Creation operation. Solution The solution is to create a request using the following URI and method type and submit it to the server via the Data Set Entity REST service: Get Data Records for Data Set /rest/serverengine/entity/datasets/{dataSetId} GET Example HTML5 dse-get-datarecords.

PAGE 222

PAGE 223

c.displaySubResult("JSON Identifier List", c.jsonPrettyPrint(response)); }) .fail(c.displayDefaultFailure); }); }); }(jQuery, Common)); Screenshot & Output Usage To run the example simply enter the Data Set ID and select the Submit button to request a list of the all the data records contained within the specific data set in the server.

PAGE 224

The resulting list will then be returned and displayed to the Results area in both Plain list and JSON Identifier List formats. Further Reading See the Data Set Entity Service page of the REST API Reference section for further detail.

PAGE 225

Finding all the Content Sets in the Server Problem You want to obtain a list of all the previously created Content Sets contained in the PlanetPress Connect Server potentially for use in a Job Creation operation. Solution The solution is to create a request using the following URI and method type and submit it to the server via the Content Set Entity REST service: Get All Content Sets /rest/serverengine/entity/contentsets GET Example HTML5 cse-get-all-contentsets.

PAGE 226

Email

PAGE 227

(response)); c.displaySubResult("JSON Identifier List", c.jsonPrettyPrint(response)); }) .fail(c.displayDefaultFailure); }); }); }(jQuery, Common)); Screenshot & Output Usage To run the example simply select the Submit button to request a list of the all the content sets currently contained within the server. The resulting list will then be returned and displayed to the Results area in both Plain list and JSON Identifier List formats.

PAGE 228

Further Reading See the Content Set Entity Service page of the REST API Reference section for further detail.

PAGE 229

Finding the Content Items in a Content Set Problem You want to obtain a list of all the previously created Content Items contained within a specific Content Set potentially for use in a Job Creation operation. Solution The solution is to create a request using the following URI and method type and submit it to the server via the Content Set Entity REST service: Get Content Items for Content Set /rest/serverengine/entity/contentsets/ {contentSetId} GET Example HTML5 cse-get-contentitems.

PAGE 230

PAGE 231

c.displaySubResult("JSON Content Item Identifier List", c.jsonPrettyPrint(response)); }) .fail(c.

PAGE 232

Usage To run the example simply enter the Content Set ID and select the Submit button to request a list of the all the content items contained within the specific content set in the server. The resulting list will then be returned as a list of Content Item and Data Record ID pairs which will be displayed to the Results area in both Plain table and JSON Content Item Identifier List formats. Further Reading See the Content Set Entity Service page of the REST API Reference section for further detail.

PAGE 233

Finding all the Job Sets in the Server Problem You want to obtain a list of all the previously created Job Sets contained in the PlanetPress Connect Server potentially for use in a Output Creation operation. Solution The solution is to create a request using the following URI and method type and submit it to the server via the Job Set Entity REST service: Get All Job Sets /rest/serverengine/entity/jobsets GET Example HTML5 jse-get-all-jobsets.

PAGE 234

JavaScript/jQuery jse-get-all-jobsets.js /* Job Set Entity Service - Get All Job Sets Example */ (function ($, c) { "use strict"; $(function () { c.setupExample(); $("form").on("submit", function (event) { event.preventDefault(); if (!c.checkSessionValid()) return; $.ajax({ type: "GET", url: "/rest/serverengine/entity/jobsets" }) .done(function (response) { c.displayStatus("Request Successful"); c.displayHeading("Job Set IDs"); c.displaySubResult("Plain", c.

PAGE 235

Screenshot & Output Usage To run the example simply select the Submit button to request a list of the all the job sets currently contained within the server. The resulting list will then be returned and displayed to the Results area in both Plain list and JSON Identifier List formats. Further Reading See the Job Set Entity Service page of the REST API Reference section for further detail.

PAGE 236

Finding the Jobs in a Job Set Problem You want to obtain a list of all the previously created Jobs contained within a specific Job Set potentially for use in a Output Creation operation. Solution The solution is to create a request using the following URI and method type and submit it to the server via the Job Set Entity REST service: Get Jobs for Job Set /rest/serverengine/entity/jobsets/{jobSetId} GET Example HTML5 jse-get-jobs.

PAGE 237

PAGE 238

}) .fail(c.displayDefaultFailure); }); }); }(jQuery, Common)); Screenshot & Output Usage To run the example simply enter the Job Set ID and select the Submit button to request a list of the all the jobs contained within the specific job set in the server. The resulting list will then be returned and displayed to the Results area in both Plain list and JSON Identifier List formats. Further Reading See the Job Set Entity Service page of the REST API Reference section for further detail.

PAGE 239

Working with the Workflow Services This section consists of a number of pages covering various useful working examples: 1. Running a Data Mapping Operation 2. Running a Data Mapping Operation (Using JSON) 3. Running a Data Mapping Operation for PDF/VT File (to Data Set) 4. Running a Data Mapping Operation for PDF/VT File (to Content Set) 5. Running a Content Creation Operation for Print By Data Set 6. Running a Content Creation Operation for Print By Data Record (Using JSON) 7.

PAGE 240

See the Data Mapping Service, Content Creation Service, Content Creation (Email) Service, Content Creation (HTML) Service, Job Creation Service, Output Creation Service and All-InOne Service pages of the REST API Reference section for further detail. Note A complete listing including these examples can be found in the index.html file located at the root of the working example source code which contains links to all working examples.

PAGE 241

Running a Data Mapping Operation Problem You want to run a data mapping operation to produce a Data Set using a data file and a data mapping configuration as inputs. Solution The solution is to make a series of requests using the following URIs and method types to submit, monitor progress and ultimately retrieve the result of the data mapping operation. There is also the option of cancelling an operation during processing if required.

PAGE 242

PAGE 243

JavaScript/jQuery dm-process.js /* Data Mapping Service - Process Data Mapping Example */ (function ($, c) { "use strict"; $(function () { c.setupExample(); var $submitButton = $("#submit"), $cancelButton = $("#cancel"), $progressBar = $("progress"), operationId = null; $cancelButton.on("click", function () { if (operationId !== null) { /* Cancel an Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/datamining/cancel/" + operationId }) .done(function (response) { c.

PAGE 244

var configId = $("#datamapper").val(), dataFileId = $("#datafile").val(), validate = $("#validate").prop("checked"); var getFinalResult = function () { /* Get Result of Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/datamining/getResult/" + operationId }) .done(function (response, status, request) { c.displayHeading("Operation Result"); if (validate) c.displaySubResult("JSON Data Mapping Validation Result", c.jsonPrettyPrint(response)); else c.

PAGE 245

c.displayResult("Operation ID", operationId); var getProgress = function () { if (operationId !== null) { /* Get Progress of Operation */ $.ajax({ type: "GET", cache: false, url: "/rest/serverengine/workflow/datamining/getProgress/" + operationId }) .done(function (response, status, request) { if (response !== "done") { if (response !== progress) { progress = response; $progressBar.attr ("value", progress); } setTimeout(getProgress, 1000); } else { $progressBar.attr("value", (progress = 100)); c.

PAGE 246

}; getProgress(); }) .fail(c.

PAGE 247

l Validate Only – Only validate the Data Mapping operation to check for mapping errors (no Data Set is created). Lastly, select the Submit button to start the data mapping operation. Once the operation has started processing, the Operation ID will be displayed in the Results area and the Cancel button will become enabled, giving you the option to cancel the running operation.

PAGE 248

Running a Data Mapping Operation (Using JSON) Problem You want to run a data mapping operation to produce a Data Set using a data file and a data mapping configuration as inputs. Solution The solution is to make a series of requests using the following URIs and method types to submit, monitor progress and ultimately retrieve the result of the data mapping operation. There is also the option of cancelling an operation during processing if required.

PAGE 249

PAGE 250

JavaScript/jQuery dm-process-json.js /* Data Mapping Service - Process Data Mapping (JSON) Example */ (function ($, c) { "use strict"; $(function () { c.setupExample(); var $submitButton = $("#submit"), $cancelButton = $("#cancel"), $progressBar = $("progress"), operationId = null; $cancelButton.on("click", function () { if (operationId !== null) { /* Cancel an Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/datamining/cancel/" + operationId }) .done(function (response) { c.

PAGE 251

var configId = $("#datamapper").val(), dataFileId = $("#datafile").val(), validate = $("#validate").prop("checked"); var getFinalResult = function () { /* Get Result of Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/datamining/getResult/" + operationId }) .done(function (response, status, request) { c.displayHeading("Operation Result"); if (validate) { c.displaySubResult("JSON Data Mapping Validation Result", c.jsonPrettyPrint(response)); } else { c.

PAGE 252

$cancelButton.prop("disabled", false); c.displayStatus("Data Mapping Operation Successfully Submitted"); c.displayResult("Operation ID", operationId); var getProgress = function () { if (operationId !== null) { /* Get Progress of Operation */ $.ajax({ type: "GET", cache: false, url: "/rest/serverengine/workflow/datamining/getProgress/" + operationId }) .done(function (response, status, request) { if (response !== "done") { if (response !== progress) { progress = response; $progressBar.

PAGE 253

} }) .fail(c.displayDefaultFailure); } }; getProgress(); }) .fail(c.

PAGE 254

Usage To run the example simply enter the Managed File ID or Name for your data file and your data mapping configuration (previously uploaded to the file store) into the appropriate text fields, and then check any options that you may require: l Validate Only – Only validate the Data Mapping operation to check for mapping errors (no Data Set is created). Lastly, select the Submit button to start the data mapping operation.

PAGE 255

Running a Data Mapping Operation for PDF/VT File (to Data Set) Problem You want to run a data mapping operation to produce a Data Set using only a PDF/VT file as input. Solution The solution is to make a series of requests using the following URIs and method types to submit, monitor progress and ultimately retrieve the result of the data mapping operation. There is also the option of cancelling an operation during processing if required.

PAGE 256

PAGE 257

$(function () { c.setupExample(); var $submitButton = $("#submit"), $cancelButton = $("#cancel"), $progressBar = $("progress"), operationId = null; $cancelButton.on("click", function () { if (operationId !== null) { /* Cancel an Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/datamining/cancel/" + operationId }) .done(function (response) { c.displayInfo("Operation Cancelled!"); operationId = null; setTimeout(function () { $progressBar.attr("value", 0); $submitButton.

PAGE 258

url: "/rest/serverengine/workflow/datamining/getResult/" + operationId }) .done(function (response, status, request) { c.displayHeading("Operation Result"); c.displaySubResult("Data Set ID", response); }) .fail(c.displayDefaultFailure); }; /* Process Data Mapping (PDF/VT to Data Set) */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/datamining/pdfvtds/" + dataFileId }) .done(function (response, status, request) { var progress = null; operationId = request.

PAGE 259

if (response !== "done") { if (response !== progress) { progress = response; $progressBar.attr ("value", progress); } setTimeout(getProgress, 1000); } else { $progressBar.attr("value", (progress = 100)); c.displayInfo("Operation Completed"); getFinalResult(); operationId = null; setTimeout(function () { $progressBar.attr ("value", 0); $submitButton.prop ("disabled", false); $cancelButton.prop ("disabled", true); }, 100); } }) .fail(c.displayDefaultFailure); } }; getProgress(); }) .fail(c.

PAGE 260

Screenshot & Output Usage To run the example simply enter the Managed File ID or Name for your PDF/VT file (previously uploaded to the file store) into the appropriate text field, and then select the Submit button to start the data mapping operation. Once the operation has started processing, the Operation ID will be displayed in the Results area and the Cancel button will become enabled, giving you the option to cancel the running operation.

PAGE 261

Running a Data Mapping Operation for PDF/VT File (to Content Set) Problem You want to run a data mapping operation to produce a Content Set using only a PDF/VT file as input. Solution The solution is to make a series of requests using the following URIs and method types to submit, monitor progress and ultimately retrieve the result of the data mapping operation. There is also the option of cancelling an operation during processing if required.

PAGE 262

PAGE 263

$(function () { c.setupExample(); var $submitButton = $("#submit"), $cancelButton = $("#cancel"), $progressBar = $("progress"), operationId = null; $cancelButton.on("click", function () { if (operationId !== null) { /* Cancel an Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/datamining/cancel/" + operationId }) .done(function (response) { c.displayInfo("Operation Cancelled!"); operationId = null; setTimeout(function () { $progressBar.attr("value", 0); $submitButton.

PAGE 264

url: "/rest/serverengine/workflow/datamining/getResult/" + operationId }) .done(function (response, status, request) { c.displayHeading("Operation Result"); c.displaySubResult("Content Set ID", response); }) .fail(c.displayDefaultFailure); }; /* Process Data Mapping (PDF/VT to Content Set) */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/datamining/pdfvtcs/" + dataFileId }) .done(function (response, status, request) { var progress = null; operationId = request.

PAGE 265

if (response !== "done") { if (response !== progress) { progress = response; $progressBar.attr ("value", progress); } setTimeout(getProgress, 1000); } else { $progressBar.attr("value", (progress = 100)); c.displayInfo("Operation Completed"); getFinalResult(); operationId = null; setTimeout(function () { $progressBar.attr ("value", 0); $submitButton.prop ("disabled", false); $cancelButton.prop ("disabled", true); }, 100); } }) .fail(c.displayDefaultFailure); } }; getProgress(); }) .fail(c.

PAGE 266

Screenshot & Output Usage To run the example simply enter the Managed File ID or Name for your PDF/VT file (previously uploaded to the file store) into the appropriate text field, and then select the Submit button to start the data mapping operation. Once the operation has started processing, the Operation ID will be displayed in the Results area and the Cancel button will become enabled, giving you the option to cancel the running operation.

PAGE 267

Running a Content Creation Operation for Print By Data Set Problem You want to run a content creation operation to produce a Content Set using a template and an existing set of Data Records as inputs. Solution The solution is to make a series of requests using the following URIs and method types to submit, monitor progress and ultimately retrieve the result of the content creation operation. There is also the option of cancelling an operation during processing if required.

PAGE 268

3.4.1.min.js"> PAGE 269

/* Content Creation Service - Process Content Creation (By Data Set) Example */ (function ($, c) { "use strict"; $(function () { c.setupExample(); var $submitButton = $("#submit"), $cancelButton = $("#cancel"), $progressBar = $("progress"), operationId = null; $cancelButton.on("click", function () { if (operationId !== null) { /* Cancel an Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/contentcreation/cancel/" + operationId }) .done(function (response) { c.

PAGE 270

var getFinalResult = function () { /* Get Result of Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/contentcreation/getResult/" + operationId }) .done(function (response, status, request) { c.displayHeading("Operation Result"); c.displaySubResult("Content Set IDs", response); }) .fail(c.displayDefaultFailure); }; /* Process Content Creation (By Data Set) */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/contentcreation/" + templateId + "/" + dataSetId }) .

PAGE 271

cache: false, url: "/rest/serverengine/workflow/contentcreation/getProgress/" + operationId }) .done(function (response, status, request) { if (response !== "done") { if (response !== progress) { progress = response; $progressBar.attr ("value", progress); } setTimeout(getProgress, 1000); } else { $progressBar.attr("value", (progress = 100)); c.displayInfo("Operation Completed"); getFinalResult(); operationId = null; setTimeout(function () { $progressBar.attr ("value", 0); $submitButton.

PAGE 272

Screenshot & Output Usage To run the example simply enter the Data Set ID and the Managed File ID or Name of your template (previously uploaded to the file store) into the appropriate text fields, and then select the Submit button to start the content creation operation. Once the operation has started processing, the Operation ID will be displayed in the Results area and the Cancel button will become enabled, giving you the option to cancel the running operation.

PAGE 273

Running a Content Creation Operation for Print By Data Record (Using JSON) Problem You want to run a content creation operation to produce a Content Set using a template and an existing set of Data Records as inputs. Solution The solution is to make a series of requests using the following URIs and method types to submit, monitor progress and ultimately retrieve the result of the content creation operation. There is also the option of cancelling an operation during processing if required.

PAGE 274

PAGE 275

JavaScript/jQuery cc-process-by-dre-json.js /* Content Creation Service - Process Content Creation (By Data Record) (JSON) Example */ (function ($, c) { "use strict"; $(function () { c.setupExample(); var $submitButton = $("#submit"), $cancelButton = $("#cancel"), $progressBar = $("progress"), operationId = null; $cancelButton.on("click", function () { if (operationId !== null) { /* Cancel an Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/contentcreation/cancel/" + operationId }) .

PAGE 276

var dataRecordIds = $("#datarecords").val(), templateId = $("#template").val(); var getFinalResult = function () { /* Get Result of Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/contentcreation/getResult/" + operationId }) .done(function (response, status, request) { c.displayHeading("Operation Result"); c.displaySubResult("Content Set IDs", response); }) .fail(c.displayDefaultFailure); }; /* Process Content Creation (By Data Record) (JSON) */ $.

PAGE 277

var getProgress = function () { if (operationId !== null) { /* Get Progress of Operation */ $.ajax({ type: "GET", cache: false, url: "/rest/serverengine/workflow/contentcreation/getProgress/" + operationId }) .done(function (response, status, request) { if (response !== "done") { if (response !== progress) { progress = response; $progressBar.attr ("value", progress); } setTimeout(getProgress, 1000); } else { $progressBar.attr("value", (progress = 100)); c.

PAGE 278

getProgress(); }) .fail(c.displayDefaultFailure); }); }); }(jQuery, Common)); Screenshot & Output Usage To run the example simply enter a comma delimited list of your Data Record IDs and the Managed File ID or Name of your template (previously uploaded to the File Store) into the appropriate text fields, and then select the Submit button to start the content creation operation.

PAGE 279

The progress of the operation will be displayed in the progress bar, and once the content creation operation has completed, the IDs of the Content Sets created will be returned and displayed to the Results area. Further Reading See the Content Creation Service page of the REST API Reference section for further detail. Running a Content Creation Operation for Print By Data (Using JSON) Problem You want to run a content creation operation to produce a Content Set using a template and JSON data as inputs.

PAGE 280

Example HTML5 cc-process-by-data-json.html PAGE 281

value="Submit"> JavaScript/jQuery cc-process-by-data-json.js /* Content Creation Service - Process Content Creation (By Data) (JSON) Example */ (function ($, c) { "use strict"; $(function () { c.setupExample(); var $submitButton = $("#submit"), $cancelButton = $("#cancel"), $progressBar = $("progress"), operationId = null, jsonData = null; c.setupJsonDataFileInput($("#datafile"), function (data) { jsonData = data }); $cancelButton.

PAGE 282

$cancelButton.prop("disabled", true); }, 100); }) .fail(c.displayDefaultFailure); } }); $("form").on("submit", function (event) { event.preventDefault(); if (!c.checkSessionValid()) return; var templateId = $("#template").val(); var getFinalResult = function () { /* Get Result of Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/contentcreation/getResult/" + operationId }) .done(function (response, status, request) { c.displayHeading("Operation Result"); c.

PAGE 283

("operationId"); $submitButton.prop("disabled", true); $cancelButton.prop("disabled", false); c.displayStatus("Content Creation Operation Successfully Submitted"); c.displayResult("Operation ID", operationId); var getProgress = function () { if (operationId !== null) { /* Get Progress of Operation */ $.ajax({ type: "GET", cache: false, url: "/rest/serverengine/workflow/contentcreation/getProgress/" + operationId }) .

PAGE 284

("disabled", false); $cancelButton.prop ("disabled", true); }, 100); } }) .fail(c.displayDefaultFailure); } }; getProgress(); }) .fail(c.

PAGE 285

Usage To run the example you first need to use the Browse button to select an appropriate JSON Data File and then enter the Template Managed File ID/Name (previously uploaded to the File Store) into the appropriate text field as your inputs. Select the Submit button to start the content creation operation. Once the operation has started processing, the Operation ID will be displayed in the Results area and the Cancel button will become enabled, giving you the option to cancel the running operation.

PAGE 286

Example HTML5 cc-preview-pdf-by-dre.html PAGE 287

JavaScript/jQuery cc-preview-pdf-by-dre.js /* Content Creation Service - Create Preview PDF (By Data Record) Example */ (function ($, c) { "use strict"; $(function () { c.setupExample(); $("form").on("submit", function (event) { event.preventDefault(); if (!c.checkSessionValid()) return; var params = { dataRecordId: $("#datarecord").val(), templateId: $("#template").val() }; /* Create Preview PDF (By Data Record) */ $.

PAGE 288

Screenshot & Output Usage To run the example you need to select the specific Data Record ID and the Template Managed File ID/Name (previously uploaded to the File Store).

PAGE 289

Once the inputs are entered, select the Submit button to create the preview PDF. When the response returns, a Managed File ID of the preview PDF (in the file store) will be displayed in the Results area. Further Reading See the "Content Creation Service" on page 527 page of the REST API Reference section for further detail. Creating a Preview PDF for Print By Data Problem You want to create a preview PDF using a data file, data mapping configuration and a template as inputs.

PAGE 290

Content Creation Service - Create Preview PDF (By Data) Example

PAGE 291

/* Content Creation Service - Create Preview PDF (By Data) Example */ (function ($, c) { "use strict"; $(function () { c.setupExample(); $("form").on("submit", function (event) { event.preventDefault(); if (!c.checkSessionValid()) return; var file dmConfigId templateId persist = = = = $("#datafile")[0].files[0], $("#datamapper").val(), $("#template").val(), $("#persist").prop("checked"); /* Create Preview PDF (By Data) */ $.

PAGE 292

Screenshot & Output Usage To run the example you first need to use the Browse button to select an appropriate Data File to use as an input using the selection dialog box. Next, you need to enter the Managed File ID or Name of both your data mapping configuration and template (previously uploaded to the file store) into the appropriate text fields.

PAGE 293

Further Reading See the "Content Creation Service" on page 527 page of the REST API Reference section for further detail. Creating a Preview PDF for Print By Data (Using JSON) Problem You want to create a preview PDF using JSON data and a template as inputs.

PAGE 294

Inputs

PAGE 295

var templateId = $("#template").val(); /* Create Preview PDF (By Data) (JSON) */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/contentcreation/pdfpreview/" + templateId, data: JSON.stringify({ data: jsonData }), contentType: "application/json" }) .done(function (response, status, request) { c.displayStatus("Request Successful"); c.displayResult("Managed File ID", response); }) .fail(c.

PAGE 296

Usage To run the example you first need to use the Browse button to select an appropriate JSON Data File to use as an input using the selection dialog box. Next, you need to enter the Managed File ID or Name of your template (previously uploaded to the file store) into the appropriate text field. Once the inputs are selected/entered, select the Submit button to create the preview PDF. When the response returns, a Managed File ID of the preview PDF (in the file store) will be displayed in the Results area.

PAGE 297

PAGE 298

placeholder="Section Name">

PAGE 300

true); }, "Invalid Pages value entered"); if (event.target.validity.valid && $archive.val() === "false" && c.validateNumericRange(event.target.value, true, true)) { $archive.val("true"); } }) .trigger("change"); $("#context") .on("change", function (event) { var isDefault = ($(event.target).val() === "default"), isPrint = ($(event.target).val() === "print"); $pages.prop("disabled", (!isDefault && !isPrint)); $bleed.prop("disabled", (!isDefault && !isPrint)); $viewPortWidth.

PAGE 301

if (context !== "default") config.context = context; if (section.length) config.section = section; if (!$quality.prop("disabled")) config.quality = $quality.val(); if (archive !== "default") config.archive = (archive === "true"); if (!$bleed.prop("disabled")) config.bleed = $bleed.prop("checked"); if (!$viewPortWidth.prop("disabled")) config.viewPortWidth = $viewPortWidth.val(); if (!$pages.prop("disabled") && $pages.val().trim ().length) config.pages = $pages.

PAGE 302

Screenshot & Output Page 302

PAGE 303

Page 303

PAGE 304

Usage To run the example you first select the appropriate Data Record ID and then add the Template Managed File ID/Name (previously uploaded to the File Store) into the appropriate text fields as your inputs. Next, you can specify the following JSON Image Parameters to use when creating the preview image: l l Context – the context in the template to be used in the creation of the preview image (Default value is determined by the first context in the template).

PAGE 305

Alternatively, if the Context image parameter is set to a value of Email or Web, then the following image parameter can also be specified: l Viewport Width – the image width of the preview image in pixels. Once the inputs and image parameters have been entered/specified, select the Submit button to create the preview image. When the response returns, a download link of the preview image (or images) will be displayed in the Results area.

PAGE 306

Example PAGE 307

JPEG PNG

PAGE 308

JavaScript/jQuery cc-preview-image-by-data-json.js /* Content Creation Service - Create Preview Image (By Data) (JSON) Example */ (function ($, c) { "use strict"; $(function () { c.setupExample(); var $quality = $("#quality"), $archive = $("#archive"), $bleed = $("#bleed"), $pages = $("#pages"), $viewPortWidth = $("#viewPortWidth"), jsonData = null; c.setupJsonDataFileInput($("#datafile"), function (data) { jsonData = data }); $("#type") .

PAGE 309

"Invalid Pages value entered"); if (event.target.validity.valid && $archive.val() === "false" && c.validateNumericRange(event.target.value, true, true)) { $archive.val("true"); } }) .trigger("change"); $("#context") .on("change", function (event) { var isDefault = ($(event.target).val() === "default"), isPrint = ($(event.target).val() === "print"); $pages.prop("disabled", (!isDefault && !isPrint)); $bleed.prop("disabled", (!isDefault && !isPrint)); $viewPortWidth.

PAGE 310

if (context !== "default") config.context = context; if (section.length) config.section = section; if (!$quality.prop("disabled")) config.quality = $quality.val(); if (archive !== "default") config.archive = (archive === "true"); if (!$bleed.prop("disabled")) config.bleed = $bleed.prop("checked"); if (!$viewPortWidth.prop("disabled")) config.viewPortWidth = $viewPortWidth.val(); if (!$pages.prop("disabled") && $pages.val().trim ().length) config.pages = $pages.

PAGE 311

Screenshot & Output Page 311

PAGE 312

Page 312

PAGE 313

Usage To run the example you first need to use the Browse button to select an appropriate JSON Data File to use as an input using the selection dialog box. Next, you need to enter the Managed File ID or Name of your template (previously uploaded to the file store) into the appropriate text field.

PAGE 314

Alternatively, if the Context image parameter is set to a value of Email or Web, then the following image parameter can also be specified: l Viewport Width – the image width of the preview image in pixels. Once the inputs and image parameters have been entered/specified, select the Submit button to create the preview image. When the response returns, a download link of the preview image (or images) will be displayed in the Results area.

PAGE 315

Running a Content Creation Operation for Email By Data Record (Using JSON) Problem You want to run a content creation operation to create and potentially send email content using a template and an existing set of Data Records as inputs. Solution The solution is to make a series of requests using the following URIs and method types to submit, monitor progress and ultimately retrieve the result of the content creation operation.

PAGE 316

PAGE 317

From Name:

PAGE 319

$host = $("#host"), $eml = $("#eml"), $useAuth = $("#useauth"), $startTLS = $("#starttls"), $username = $("#username"), $password = $("#password"), $submitButton = $("#submit"), $cancelButton = $("#cancel"), $progressBar = $("progress"), operationId = null; $cancelButton.on("click", function () { if (operationId !== null) { /* Cancel an Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/contentcreation/email/cancel/" + operationId }) .done(function (response) { c.

PAGE 320

.trigger("change"); $host .on("change", function (event) { var host = event.target.value.trim(); $useAuth .prop("disabled", !host.length) .trigger("change"); $sender .prop("disabled", !host.length) .trigger("change"); $eml .prop("disabled", host.length) .trigger("change"); }) .trigger("change"); $eml .on("change", function (event) { if (!$host.val().trim().length) $sender .prop("disabled", !$(event.target).prop ("checked")) .trigger("change"); }) .trigger("change"); $useAuth .

PAGE 321

var dataRecordIds = $("#datarecords").val(), templateId = $("#template").val(), section = $("#section").val().trim(), host = $host.val().trim(); var getFinalResult = function () { /* Get Result of Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/contentcreation/email/getResult/" + operationId }) .done(function (response, status, request) { c.displayHeading("Operation Result"); if (host.length) c.displaySubResult("Email Report", response); else c.

PAGE 322

true; } if (host.length) { config.host = host; if ($useAuth.prop("checked")) config.useAuth = true; if (config.useAuth) { if ($startTLS.prop("checked")) config.useStartTLS = true; config.user = $username.val(); config.password = $password.val(); } } else { if ($eml.prop("checked")) config.eml = true; } if (attachPdfPage !== "default") config.attachPdfPage = (attachPdfPage === "true"); if ($("#attachweb").prop("checked")) config.

PAGE 323

Successfully Submitted"); c.displayResult("Operation ID", operationId); var getProgress = function () { if (operationId !== null) { /* Get Progress of Operation */ $.ajax({ type: "GET", cache: false, url: "/rest/serverengine/workflow/contentcreation/email/getProgress/" + operationId }) .done(function (response, status, request) { if (response !== "done") { if (response !== progress) { progress = response; $progressBar.attr ("value", progress); } setTimeout(getProgress, 1000); } else { $progressBar.

PAGE 324

.fail(c.displayDefaultFailure); } }; getProgress(); }) .fail(c.

PAGE 325

Screenshot & Output Page 325

PAGE 326

Usage To run the example you first need to enter a comma delimited list of your Data Record IDs and the Managed File ID or Name of your template (previously uploaded to the file store) into the appropriate text fields as your inputs. The example can then be configured (via the specification of email parameters) to run in one of two ways: l Create email output to the Connect File Store. l Create email output directly to a SMTP mail server.

PAGE 327

l l l Section – the section within the Email context of the template to use. Attach Print Context as PDF – if a Print context exists in the template, create its output as a PDF file and attach it to the email output (Default value depends on Template). Attach Web Context as HTML – if a Web context exists in the template, create output of its enabled sections (a single section by default) as HTML files and attach them to the email output.

PAGE 328

Further Reading See the Content Creation (Email) Service page of the REST API Reference section for further detail. Running a Content Creation Operation for Email By Data (Using JSON) Problem You want to run a content creation operation to create and potentially send email content using a template and JSON data as inputs.

PAGE 329

Example HTML5 cce-process-by-data-json.html PAGE 330

PAGE 332

var $sender = $("#sender"), $senderName = $("#sendername"), $useSender = $("#usesender"), $host = $("#host"), $eml = $("#eml"), $useAuth = $("#useauth"), $startTLS = $("#starttls"), $username = $("#username"), $password = $("#password"), $submitButton = $("#submit"), $cancelButton = $("#cancel"), $progressBar = $("progress"), operationId = null, jsonData = null; c.setupJsonDataFileInput($("#datafile"), function (data) { jsonData = data }); $cancelButton.

PAGE 333

.on("change", function (event) { var sender = event.target.value.trim(), disabled = $(event.target).prop("disabled"); $senderName.prop("disabled", (disabled || !sender.length)); $useSender.prop("disabled", (disabled || !sender.length)); }) .trigger("change"); $host .on("change", function (event) { var host = event.target.value.trim(); $useAuth .prop("disabled", !host.length) .trigger("change"); $sender .prop("disabled", !host.length) .trigger("change"); $eml .prop("disabled", host.length) .

PAGE 334

}); }) .trigger("change"); $("form").on("submit", function (event) { event.preventDefault(); if (!c.checkSessionValid()) return; var templateId = $("#template").val(), section = $("#section").val().trim(), host = $host.val().trim(); var getFinalResult = function () { /* Get Result of Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/contentcreation/email/getResult/" + operationId }) .done(function (response, status, request) { c.displayHeading("Operation Result"); if (host.length) c.

PAGE 335

if (!$sender.prop("disabled") && sender.length) { config.sender = sender; var senderName = $senderName.val().trim(); if (senderName.length) config.senderName = senderName; if ($useSender.prop("checked")) config.useSender = true; } if (host.length) { config.host = host; if ($useAuth.prop("checked")) config.useAuth = true; if (config.useAuth) { if ($startTLS.prop("checked")) config.useStartTLS = true; config.user = $username.val(); config.password = $password.val(); } } else { if ($eml.

PAGE 336

("operationId"); $submitButton.prop("disabled", true); $cancelButton.prop("disabled", false); c.displayStatus("Content Creation Operation Successfully Submitted"); c.displayResult("Operation ID", operationId); var getProgress = function () { if (operationId !== null) { /* Get Progress of Operation */ $.ajax({ type: "GET", cache: false, url: "/rest/serverengine/workflow/contentcreation/email/getProgress/" + operationId }) .

PAGE 337

("disabled", false); $cancelButton.prop ("disabled", true); }, 100); } }) .fail(c.displayDefaultFailure); } }; getProgress(); }) .fail(c.

PAGE 338

Screenshot & Output Page 338

PAGE 339

Page 339

PAGE 340

Usage To run the example you first need to use the Browse button to select an appropriate JSON Data File and then enter the Managed File ID\Name of your template (previously uploaded to the file store) into the appropriate text fields as your inputs. The example can then be configured (via the specification of email parameters) to run in one of two ways: l Create email output to the Connect File Store. l Create email output directly to a SMTP mail server.

PAGE 341

l l l Section – the section within the Email context of the template to use. Attach Print Context as PDF – if a Print context exists in the template, create its output as a PDF file and attach it to the email output (Default value depends on Template). Attach Web Context as HTML – if a Web context exists in the template, create output of its enabled sections (a single section by default) as HTML files and attach them to the email output.

PAGE 342

Further Reading See the Content Creation (Email) Service page of the REST API Reference section for further detail.

PAGE 343

Creating Content for Web By Data Record Problem You want to create and retrieve web content using a template and an existing Data Record as inputs. Solution The solution is to create a request using the following URI and method type and submit it to the server via the Content Creation (HTML) REST service: Process Content Creation (By Data Record) /rest/serverengine/workflow/contentcreation/html/ {templateId}/{dataRecordId: [0-9]+} GET Example HTML5 cch-process-by-dre.

PAGE 344

PAGE 357

url: "/rest/serverengine/workflow/contentcreation/html/" + templateId + "?inline=" + inline, data: JSON.stringify({ data: jsonData }), contentType: "application/json", dataType: "file" }; if (section.length) settings.url += "§ion=" + section; if (cssSelector.length) settings.url += "&cssSelector=" + escape(cssSelector); $.ajax(settings) .done(function (response, status, request) { c.displayStatus("Request Successful"); c.displayResult("Result", c.dataToFileLink (response, "Output"), false); }) .fail(c.

PAGE 358

Screenshot & Output Usage To run the example you first need to use the Browse button to select an appropriate JSON Data File and then enter the Managed File ID or Name of your template (previously uploaded to the file store) into the appropriate text field. Next you can specify the HTML parameters to use when creating the web content: l Section – the section within the Web context of the template to use. l Inline Mode – the inline mode to be used in the creation of content.

PAGE 359

l CSS Selector – a CSS selector for the creation of only a specific HTML element within the template. Lastly, select the Submit button to create and retrieve the web content. When the response returns a Result Link will be displayed in the Results area. This link can be selected to view the resulting web content that was created. Further Reading See the Content Creation (HTML) Service page of the REST API Reference section for further detail.

PAGE 360

Running a Job Creation Operation By Content Set (Using JSON) Problem You want to run a job creation operation to produce a Job Set using a job creation preset and an existing set of Content Sets as inputs. Solution The solution is to make a series of requests using the following URIs and method types to submit, monitor progress and ultimately retrieve the result of the job creation operation. There is also the option of cancelling an operation during processing if required.

PAGE 361

3.4.1.min.js">

Job Creation Service - Process Job Creation (By Content Set) (JSON) Example

PAGE 363

var getFinalResult = function () { /* Get Result of Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/jobcreation/getResult/" + operationId }) .done(function (response, status, request) { c.displayHeading("Operation Result"); c.displaySubResult("Job Set ID", response); }) .fail(c.displayDefaultFailure); }; /* Process Job Creation (By Content Set) (JSON) */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/jobcreation/" + configId, data: JSON.stringify(c.

PAGE 364

cache: false, url: "/rest/serverengine/workflow/jobcreation/getProgress/" + operationId }) .done(function (response, status, request) { if (response !== "done") { if (response !== progress) { progress = response; $progressBar.attr ("value", progress); } setTimeout(getProgress, 1000); } else { $progressBar.attr("value", (progress = 100)); c.displayInfo("Operation Completed"); getFinalResult(); operationId = null; setTimeout(function () { $progressBar.attr ("value", 0); $submitButton.

PAGE 365

Screenshot & Output Usage To run the example simply enter a comma delimited list of your Content Set IDs and the Managed File ID or Name of your job creation preset (previously uploaded to the file store) into the appropriate text fields, and then select the Submit button to start the job creation operation. Once the operation has started processing, the Operation ID will be displayed in the Results area and the Cancel button will become enabled, giving you the option to cancel the running operation.

PAGE 366

Running a Job Creation Operation By Content Set with Runtime Parameters (Using JSON) Problem You want to run a job creation operation to produce a Job Set using a job creation preset, an existing set of Content Sets and runtime parameters as inputs. Solution The solution is to make a series of requests using the following URIs and method types to submit, monitor progress and ultimately retrieve the result of the job creation operation.

PAGE 367

PAGE 368

String

PAGE 404

String Number Boolean Date PAGE 405

$parameters = $jcpreset = $jobs = $ocpreset = $persistdres = $createonly = $resultastxt = $printrange = $("#parameters"), $("#jcpreset"), $("#jobs"), $("#ocpreset"), $("#persistdres"), $("#createonly"), $("#resultastxt"), $("#printrange"), AIOConfig = outputDesc = operationId = null, null, null, $submitButton = $("#submit"), $cancelButton = $("#cancel"), $progressBar = $("progress"); c.setupRuntimeParametersTableInput($parameters); $printrange .on("change", function (event) { c.

PAGE 406

}, 100); }) .fail(c.displayDefaultFailure); } }); /** * @function generateAIOConfig * @description Validates the workflow selected by the user * and constructs and an All-In-One Configuration using the relevant * input fields in the HTML Form. * Any invalid inputs or workflow selections will be redflagged in * the HTML Form. Null can also be returned if no workflow selections * are made or if the workflow selections made are of an invalid sequence.

PAGE 407

*/ booleanValue = function ($input) { return $input.prop("checked"); }; /* Get Input Value and add it to the Configuration (Helper Function) */ function getInputValue($input, process, field, parser) { var value = $input.val().

PAGE 408

missing = []; for (i = 0; i < required.length; i += 1) { var step = required[i]; if (config[step]) { if (!matches && step === "jobcreation") missing.push("contentcreation"); matches += 1; } else { if (matches !== 0) missing.push(step); } if (matches === selections) break; } /* Add the inputs to the Workflow Selections to Create the All-In-One Configuration */ if (config.

PAGE 409

if (config.outputcreation) { getInputValue($ocpreset, "outputcreation", "config"); getInputValue($createonly, "outputcreation", "createOnly", booleanValue); if (!config.contentcreation) { getInputValue($jobs, "outputcreation", "identifiers", jsonIDListValue); $jobs.prop("disabled", false); } else { $jobs.prop("disabled", true); } $createonly.prop("disabled", false); $resultastxt.prop("disabled", false); outputDesc = "Output"; } else { $createonly.prop("disabled", true); $resultastxt.

PAGE 410

if (config.jobcreation && !config.jobcreation.config && config.jobcreation.parameters) { $jcpreset.prop("required", true); } else { $jcpreset.prop("required", false); } /* Red-flag any omissions in Workflow Selections */ if (!selections || missing.length) { for (i = 0; i < missing.length; i += 1) $("#" + missing[i]).prop("required", true); return null; } return config; } $inputs .on("change", function (event) { var input = event.target; var process = $("#" + input.id + "-inputs"); process.

PAGE 411

var getFinalResult = function () { var resultastxt = $resultastxt.prop("checked"), result = (resultastxt) ? "getResultTxt" : "getResult"; /* Get Result of Operation */ var settings = { type: "POST", url: "/rest/serverengine/workflow/print/" + result + "/" + operationId }; if (!resultastxt) settings.dataType = "file"; $.ajax(settings) .done(function (response, status, request) { c.displayHeading("Operation Result"); if (!resultastxt) { c.displaySubResult(outputDesc, c.

PAGE 412

$cancelButton.prop("disabled", false); c.displayStatus("All-In-One Operation Successfully Submitted"); c.displayHeading("Input Configuration"); c.displaySubResult("JSON All-In-One Configuration", c.jsonPrettyPrint(AIOConfig)); c.displayResult("Operation ID", operationId); var getProgress = function () { if (operationId !== null) { /* Get Progress of Operation */ $.ajax({ type: "GET", cache: false, url: "/rest/serverengine/workflow/print/getProgress/" + operationId }) .

PAGE 413

("value", 0); $submitButton.prop ("disabled", false); $cancelButton.prop ("disabled", true); }, 100); } }) .fail(c.displayDefaultFailure); } }; getProgress(); }) .fail(c.displayDefaultFailure); }) .

PAGE 414

Screenshot & Output Page 414

PAGE 415

Page 415

PAGE 416

Usage To run the example simply select the input combination of your choosing, populate the appropriate input fields and then check any options that you may require. The following file based input fields can be referenced by Managed File ID\Name: l Data file l Data Mapping configuration l Template l Job Creation preset l Output Creation preset Specific to the specification of a Job Creation Preset, one or more Runtime Parameters can also be specified.

PAGE 417

The following option is only available if the input combination specifically includes the data mapping process but with no job creation preset specified: l Persist Data Records – Create/persist data records entities in the server during the data mapping process (intended for use with once-off jobs where the storage of data records in the server is not required). Lastly, select the Submit button to start the All-In-One operation.

PAGE 418

Solution The solution is to make a series of requests using the following URIs and method types to submit, monitor progress and ultimately retrieve the result of the All-In-One operation.

PAGE 419

PAGE 420

Text:

PAGE 421

.on("change", function (event) { c.setCustomInputValidity(event.target, c.validateNumericRange, "Invalid Print Range value entered"); }) .trigger("change"); $cancelButton.on("click", function () { if (operationId !== null) { /* Cancel an Operation */ $.ajax({ type: "POST", url: "/rest/serverengine/workflow/print/cancel/" + operationId }) .done(function (response) { c.displayInfo("Operation Cancelled!"); operationId = null; setTimeout(function () { $progressBar.attr("value", 0); $submitButton.

PAGE 422

resultAsTxt = $("#resultastxt").prop("checked"), printRange = $printrange.val(); var getFinalResult = function () { var result = (resultAsTxt) ? "getResultTxt" : "getResult"; /* Get Result of Operation */ var settings = { type: "POST", url: "/rest/serverengine/workflow/print/" + result + "/" + operationId }; if (!resultAsTxt) settings.dataType = "file"; $.ajax(settings) .done(function (response, status, request) { c.displayHeading("Operation Result"); if (!resultAsTxt) { c.displaySubResult("Output", c.

PAGE 423

if (!resultAsTxt && !async) settings.dataType = "file"; if (printRange.length > 0) settings.url += "&printRange=" + printRange; $.ajax(settings) .done(function (response, status, request) { if (async) { var progress = null; operationId = request.getResponseHeader ("operationId"); $submitButton.prop("disabled", true); $cancelButton.prop("disabled", false); c.displayStatus("All-In-One Operation Successfully Submitted"); c.

PAGE 424

} else { $progressBar.attr ("value", (progress = 100)); c.displayInfo ("Operation Completed"); getFinalResult(); operationId = null; setTimeout(function () { $progressBar.attr ("value", 0); $submitButton.prop ("disabled", false); $cancelButton.prop ("disabled", true); }, 100); } }) .fail(c.displayDefaultFailure); } }; getProgress(); } else { c.displayInfo("Operation Completed"); c.displayHeading("Operation Result"); if (!resultAsTxt) { c.displaySubResult("Output", c.

PAGE 425

Screenshot & Output Usage To run the example, you first need to use the Browse button to select an appropriate Data File to use as an input using the selection dialog box.

PAGE 426

If required, a Job Creation preset can also be referenced by specifying a Managed File ID or Name. The following options can be specified : l l l l Asynchronous – Run the All-In-One operation asynchronously with the operation progress being displayed and the option to cancel the running operation. Create Only – Create the output in server but do not send spool file to its final destination.

PAGE 427

REST API Reference The PlanetPress Connect REST API defines a number of RESTful services that facilitate various functionality within the server during workflow processing. The following table is a summary of the services available in the PlanetPress Connect REST API: Service Name Internal Name Description Authentication Service AuthenticationRestService This service exposes methods concerned with server security and authentication with the PlanetPress Connect REST API.

PAGE 428

Service Name Internal Name Description set, data records or JSON as input l l l Content Item Entity Service ContentItemEntityRestService Getting a list of all the active operations on the server Getting the result of a content creation operation for print Creation of single record preview PDFs using either a data file, data record or JSON as input This service exposes methods specific to the access and management of content item entities internal to the server.

PAGE 429

Service Name Internal Name Description IDs within the server l l l l Getting the content item IDs contained within a content set Getting the page details for a content set Getting and updating of content set properties Deletion of content sets from the server Conversion Service ConversionRestService This service exposes methods specific to file conversions.

PAGE 430

Service Name Internal Name Description internal to the server. It includes methods to facilitate the following functions: l l l l Data Mapping Service DataminingRestService Getting all the data set IDs within the server Getting the data record IDs contained within a data set Getting and updating of data set properties Deletion of data sets from the server This service exposes methods specific to the management of the data mapping process within the workflow.

PAGE 431

Service Name Internal Name Description mapping operation Document Entity Service DocumentEntityRestService This service exposes methods specific to the access and management of document entities internal to the server.

PAGE 432

Service Name Internal Name Description l l l Entity Service EntityRestService Creation, monitoring and cancellation of content creation operations for email using data records or JSON as input Getting a list of all the active operations on the server Getting the result of a content creation operation for email This service exposes methods specific to the querying and selection of data entities internal to the server.

PAGE 433

Service Name Internal Name Description store l l l l Content Creation (HTML) Service HTMLMergeRestService Uploading of templates to the File Store Uploading of job creation and output creation presets to the file store Download of managed files from the file store Deletion of managed files from the file store This service exposes methods specific to the management of the content creation process for the Web context within the workflow.

PAGE 434

Service Name Internal Name Description It includes methods to facilitate the following functions: l l l Job Entity Service JobEntityRestService Creation, monitoring and cancellation of job creation operations using either content sets or content items as input Getting a list of all the active operations on the server Getting the result of a job creation operation This service exposes methods specific to the access and management of job entities internal to the server.

PAGE 435

Service Name Internal Name Description It includes methods to facilitate the following functions: l l Job Set Entity Service JobSetEntityRestService Getting the document set IDs contained within a job segment Getting and updating of job segment metadata properties This service exposes methods specific to the access and management of job set entities internal to the server.

PAGE 436

Service Name Internal Name Description l l l l All-In-One Service PrintRestService Creation, monitoring and cancellation of output creation operations using either a job set or jobs as input Getting a list of all the active operations on the server Getting the result of an output creation operation Running of +PReS Enhance workflow configurations via the Weaver engine This service exposes methods specific to the management of the All-In-One process within the workflow.

PAGE 437

All-In-One Service The following table is a summary of the resources and methods available in the All-In-One service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/workflow/print GET Process All-InOne (JSON) /rest/serverengine/workflow/print/submit POST Process All-InOne (Adhoc Data) /rest/serverengine/workflow/print/{dmConfigId}/ {templateId}/{jcConfigId}/{ocConfigId} POST Get All Operations /rest/serverengine/workflow/print/getOperations GET

PAGE 438

Cancel an Operation Requests the cancellation of a running All-In-One operation of a specific operation ID. Request takes no content, and on success returns a response with no content. Request Method Type: POST URI: /rest/serverengine/workflow/print/cancel/{operationId} Content: – Content Type: – Add.

PAGE 439

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 204 No Content – – – Operation cancellation requested Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 440

Status Code Content ContentType Add. Headers Description token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 441

Get All Operations Returns a list of all the workflow operations actively running on the Server. Request takes no content, and on success returns a response containing a JSON Operations List of all the actively running operations. Request Method Type: GET URI: /rest/serverengine/workflow/print/getOperations Content: – Content Type: – Add.

PAGE 442

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 443

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid. Get Managed Result of Operation Retrieves the Managed File ID of the final result of a completed Output Creation operation of a specific operation ID. Request takes no content, and on success returns the Managed File ID of the output (file or directory) in the File Store.

PAGE 444

Name Required Type Default Value Description operationId – – – Operation ID of All-In-One operation Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 445

Status Code Content Content-Type Add. Headers Description authorization token have been specified in the request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 446

Status Code Content Content-Type Add.

PAGE 447

Get Progress of Operation Retrieves the progress of a running All-In-One operation of a specific operation ID. Request takes no content, and on success returns a response containing the current value of operation progress (values ranging from 0 – 100, followed by the value of 'done' on completion). Request Method Type: GET URI: /rest/serverengine/workflow/print/getProgress/{operationId} Content: – Content Type: – Add.

PAGE 448

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Progress value of AllIn-One operation text/plain – Progress of operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 449

Status Code Content ContentType Add. Headers Description the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 450

Get Result of Operation Retrieves the final result of a completed All-In-One operation of a specific operation ID. Request takes no content, and on success returns a response (depending on the All-In-One configuration) containing either: l l the ID of the Data Set, Content Set or Job Set entity produced, or the absolute paths of the final output files produced (multiple spool files) or the content of a final output file (single spool file).

PAGE 451

Name Required Type Default Value Description operation Response Success The following lists status codes indicative of a successful response: Status Code Content Content-Type Add.

PAGE 452

Status Code Content Content-Type Add. Headers Description when neither basic authentication credentials nor an authorization token have been specified in the request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed.

PAGE 453

Status Code Content Content-Type Add. Headers Description invalid.

PAGE 454

Get Result of Operation (as Text) Retrieves the final result of a completed All-In-One operation of a specific operation ID. Request takes no content, and on success returns a response (depending on the All-In-One configuration) containing either: l l the ID of the Data Set, Content Set or Job Set entity produced, or the absolute path or paths of the final output file or files produced (single or multiple spool files respectively).

PAGE 455

Name Required Type Default Value Description operation Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Either: text/plain – Result of completed operation successfully retrieved l l ID of the Data Set, Content Set or Job Set Absolute Path (s) of the Output File(s) Error The following lists status codes indicative of a failed or error response: Status Code Content Content-Type Add.

PAGE 456

Status Code Content Content-Type Add. Headers Description credentials nor an authorization token have been specified in the request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 457

Status Code Content Content-Type Not Found Error" on page 37 specifying error message stream Add.

PAGE 458

Process All-In-One (JSON) Submits a request to initiate a new All-In-One operation. Request takes a JSON All-In-One Configuration as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 459

Status Code Content ContentType Add. Headers l Description Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 460

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 461

Process All-In-One (Adhoc Data) Submits a request to initiate a new All-In-One operation using pre-existing inputs, with the exception of input data, which is submitting along with the request.

PAGE 462

Parameters Path Name Required Type Default Value Description dmConfigId – – – The Managed File ID (or Name) of the Data Mapping configuration in File Store templateId – – – The Managed File ID (or Name) of the template in File Store jcConfigId Optional – the value of "0" can be specified if no preset is to be used – – The Managed File ID (or Name) of the Job Creation Preset in File Store ocConfigId – – – The Managed File ID (or Name) of the Output Creation Preset in File Store Query

PAGE 463

Name Required Type Default Value Description createOnly – – false Whether output is to be only created in the server and not sent to it's final destination printRange – – – A specific range of records in the input data file to restrict the print output to filename – – – The file name of the data file to be uploaded Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add.

PAGE 464

Status Code Content Content-Type Add. Headers Description 200 OK Absolute Paths of the Output Files or the Output File itself application/octetstream – Data file uploaded to File Store and a new operation was created and completed successfully with the result returned Success (Synchronous + Get Result as Text) The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 465

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 466

Status Code Content ContentType Add.

PAGE 467

Service Handshake Queries the availability of the All-In-One service. Request Method Type: GET URI: /rest/serverengine/workflow/print Content: – Content Type: – Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 468

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 469

Service Version Returns the version of the All-In-One service. Request Method Type: GET URI: /rest/serverengine/workflow/print/version Content: – Content Type: – Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 470

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 471

Authentication Service The following table is a summary of the resources and methods available in the Authentication service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/authentication GET Authenticate/Login to Server /rest/serverengine/authentication/login POST Service Version /rest/serverengine/authentication/version GET Page 471

PAGE 472

Authenticate/Login to Server Submits an authentication request (using credentials) to the Connect server and if successful provides access to the various other REST API services available. Request takes no content, but requires an additional Authorization header which contains a base64 encoded set of credentials (username and password). On success, the response will return an authorization token which can then be used as an additional auth_token header in any future requests made to the REST API services.

PAGE 473

Status Code Content ContentType Add. Headers Description 200 OK Authorization Token text/plain – Server authentication successful, new authorization token generated. Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication has failed. – Server authentication has failed.

PAGE 474

Service Handshake Queries the availability of the Authentication service. Request Method Type: GET URI: /rest/serverengine/authentication Content: – Content Type: – Add.

PAGE 475

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 476

Service Version Returns the version of the Authentication service. Request Method Type: GET URI: /rest/serverengine/authentication/version Content: – Content Type: – Add.

PAGE 477

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 478

Content Creation (Email) Service The following table is a summary of the resources and methods available in the Content Creation (Email) service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/workflow/contentcreation/email GET Process Content Creation (By Data Record) (JSON) /rest/serverengine/workflow/contentcreation/email/ {templateId} POST Process Content Creation (By Data) (JSON) /rest/serverengine/workflow/contentcreation/email/ {templateId}

PAGE 479

Cancel an Operation Requests the cancellation of a running Content Creation (Email) operation of a specific operation ID. Request takes no content, and on success returns a response with no content. Request Method Type: POST URI: /rest/serverengine/workflow/contentcreation/email/cancel/{operationId} Content: – Content Type: – Add.

PAGE 480

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 204 No Content – – – Operation cancellation requested Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 481

Status Code Content ContentType Add. Headers Description token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 482

Get All Operations Returns a list of all the workflow operations actively running on the Server. Request takes no content, and on success returns a response containing a JSON Operations List of all the actively running operations. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/email/getOperations Content: – Content Type: – Add.

PAGE 483

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 484

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 485

Get Progress of Operation Retrieves the progress of a running Content Creation (Email) operation of a specific operation ID. Request takes no content, and on success returns a response containing the current value of operation progress (values ranging from 0 – 100, followed by the value of 'done' on completion). Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/email/getProgress/ {operationId} Content: – Content Type: – Add.

PAGE 486

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Progress value of Content Creation (Email) operation text/plain – Progress of operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 487

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 488

Get Result of Operation Retrieves the final result of a completed Content Creation (Email) operation of a specific operation ID. Request takes no content, and on success returns a response containing a JSON Email Output List of all the email output messages created in the File Store. Alternatively, if the operation was to create email output directly to a SMTP mail server, then a response containing a report on the number of emails that were successfully sent will be returned instead.

PAGE 489

Name Required Type Default Value Description operationId – – – Operation ID of Content Creation (Email) operation Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK "JSON Email Output List" on page 55 of the email message output in File Store text/plain – Result of completed operation successfully retrieved Result of Content Creation (Email) Operation (with successful email count) (e.g.

PAGE 490

Status Code Content ContentType Add. Headers Description host value specifying the network address or name of a SMTP mail server Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 400 Bad Request – – – Context not found / Section not found 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 491

Status Code Content ContentType Add. Headers Description headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 492

Process Content Creation (By Data) (JSON) Submits a request to initiate a new Content Creation (Email) operation. Request takes a JSON Record Data List (with Email Parameters) of the data values for one or more Data Records as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 493

Query Name Required Type Default Value Description section – – Default section in template The Section of the Email context to export Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add.

PAGE 494

Status Code 401 Unauthorized Content Error message ContentType – Add. Headers Description Authentication credentials are accepted) Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed.

PAGE 495

Process Content Creation (By Data Record) (JSON) Submits a request to initiate a new Content Creation (Email) operation. Request takes a JSON Identifier List (with Email Parameters) of Data Record IDs as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 496

Query Name Required Type Default Value Description section – – Default section in template The Section of the Email context to export Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add.

PAGE 497

Status Code 401 Unauthorized Content Error message ContentType – Add. Headers Description Authentication credentials are accepted) Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed.

PAGE 498

Status Code Content ContentType Add.

PAGE 499

Service Handshake Queries the availability of the Content Creation (Email) service. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/email Content: – Content Type: – Add.

PAGE 500

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 501

Service Version Returns the version of the Content Creation (Email) service. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/email/version Content: – Content Type: – Add.

PAGE 502

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 503

Content Creation (HTML) Service The following table is a summary of the resources and methods available in the Content Creation (HTML) service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/workflow/contentcreation/html GET Process Content Creation (By Data Record) /rest/serverengine/workflow/contentcreation/html/ {templateId}/{dataRecordId: [0-9]+} GET Process Content Creation (By Data Record) (JSON) /rest/serverengine/workflow/contentcreation/htm

PAGE 504

Get Template Resource Submits a request to retrieve a resource from a template stored in the File Store. Request takes no content, and on success returns a response containing the resource from the template. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/html/{templateId}/{relPath: .+} Content: – Content Type: – Add.

PAGE 505

Response Success The following lists status codes indicative of a successful response: Status Code Content Content-Type Add. Headers Description 200 OK Resource located at the relative path within template (Depends on Resource requested) – Resource successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 506

Status Code Content ContentType Add. Headers Description 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 507

Process Content Creation (By Data) (JSON) Submits a request to create new HTML content for the Web context. Request takes a JSON Record Data List of the data values for the Data Record as content, and on success returns a response containing the HTML output produced, specific to the record data and parameters specified.

PAGE 508

Query Name Required Type Default Value Description section – – Default section in template The section within the Web context to create inline – – NONE The inline mode to be used in the creation of content.

PAGE 509

Status Code Content ContentType Add. Headers Description 200 OK The entire HTML output for the Data Record, or the inner HTML of the first element that matches the given CSS selector, or an empty string if the CSS selector produced no results text/html – Output created successfully Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 510

Status Code Content Unauthorized message ContentType Add. Headers Description authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 511

Process Content Creation (By Data Record) Submits a request to create new HTML content for the Web context. Request takes no content, and on success returns a response containing the HTML output produced, specific to the Data Record and parameters specified. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/html/{templateId}/ {dataRecordId: [0-9]+} Content: – Content Type: – Add.

PAGE 512

Query Name Required Type Default Value Description section – – Default section in template The section within the Web context to create inline – – NONE The inline mode to be used in the creation of content.

PAGE 513

Status Code Content ContentType Add. Headers Description 200 OK The entire HTML output for the Data Record, or the inner HTML of the first element that matches the given CSS selector, or an empty string if the CSS selector produced no results text/html – Output created successfully Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 514

Status Code Content Unauthorized message ContentType Add. Headers Description authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 515

Process Content Creation (By Data Record) (JSON) Submits a request to create new HTML content for the Web context. Request takes a JSON HTML Parameters as content, and on success returns a response containing the HTML output produced, specific to the Data Record and parameters specified.

PAGE 516

Name Required Type Default Value Description entity in Server Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 517

Status Code 401 Unauthorized Content Error message ContentType – Add. Headers Description BASIC (Basic Authentication credentials are accepted) required. – Server authentication has failed. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed.

PAGE 518

Status Code Content ContentType Add.

PAGE 519

Process Content Creation (No Data) Submits a request to create new HTML content for the Web context. Request takes no content, and on success returns a response containing the HTML output produced, using only the template, no input data and specific to the parameters specified. Request Method Type: POST URI: /rest/serverengine/workflow/contentcreation/html/{templateId} Content: – Content Type: – Add.

PAGE 520

Query Name Required Type Default Value Description section – – Default section in template The section within the Web context to create inline – – NONE The inline mode to be used in the creation of content.

PAGE 521

Status Code Content ContentType Add. Headers Description 200 OK The entire HTML output for the Data Record, or the inner HTML of the first element that matches the given CSS selector, or an empty string if the CSS selector produced no results text/html – Output created successfully Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 522

Status Code Content Unauthorized message ContentType Add. Headers Description authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 523

Service Handshake Queries the availability of the Content Creation (HTML) service. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/html Content: – Content Type: – Add.

PAGE 524

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 525

Service Version Returns the version of the Content Creation (HTML) service. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/html/version Content: – Content Type: – Add.

PAGE 526

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 527

Content Creation Service The following table is a summary of the resources and methods available in the Content Creation service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/workflow/contentcreation GET "Process Content Creation (By Data Set)" on page 531 /rest/serverengine/workflow/contentcreation/{templateId}/ {dataSetId} POST Process Content Creation (By Data Record) (JSON) /rest/serverengine/workflow/contentcreation/{templateId} POST Proces

PAGE 528

Method Name Uniform Resource Identifier (URI) Method Type Create Preview PDF (By Data) (JSON) /rest/serverengine/workflow/contentcreation/pdfpreview/ {templateId} POST Create Preview Image (By Data Record) (JSON) /rest/serverengine/workflow/contentcreation/imagepreview POST "Create Preview Image (By Data) (JSON)" on page 553 /rest/serverengine/workflow/contentcreation/imagepreview/ {templateId} POST Get All Operations /rest/serverengine/workflow/contentcreation/getOperations GET Get Progress

PAGE 529

Service Handshake Queries the availability of the Content Creation service. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation Content: – Content Type: – Add.

PAGE 530

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 531

Process Content Creation (By Data Set) Submits a request to initiate a new Content Creation operation. Request takes a JSON Parameters object, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 532

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add. Headers l l operationId – Operation ID of new Content Creation operation Description Creation of new operation successful Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 533

Status Code Content ContentType Add. Headers Description request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 534

Process Content Creation (By Data Record) (JSON) Submits a request to initiate a new Content Creation operation. Request takes a JSON Identifier List (with Runtime Parameters) of Data Record IDs as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 535

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add. Headers l l operationId – Operation ID of new Content Creation operation Description Creation of new operation successful Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 536

Status Code Content ContentType Add. Headers Description request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 537

Process Content Creation (By Data) (JSON) Submits a request to initiate a new Content Creation operation. Request takes a JSON Record Data List of the data values for one or more Data Records as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 538

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add. Headers l l operationId – Operation ID of new Content Creation operation Description Creation of new operation successful Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 539

Status Code Content ContentType Add. Headers Description request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 540

Create Preview PDF (By Data Record) Submits a request to create a preview PDF of the print output for a single data record. Request takes no content, and on success returns a response containing the Managed File ID for the newly created preview PDF file. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/pdfpreviewdirect Content: – Content Type: – Add.

PAGE 541

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Managed File ID text/plain – Creation of preview PDF in File Store successful Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 542

Status Code Content ContentType Add. Headers Description 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 543

Create Preview PDF (By Data) Submits a request to create a preview PDF of the print output for a single data record. Request takes binary file data as content, and on success returns a response containing the Managed File ID for the newly created preview PDF file. Request Method Type: POST URI: /rest/serverengine/workflow/contentcreation/pdfpreview/{templateId}/ {dmConfigId} Content: Data File (File) Content Type: application/octet-stream Add.

PAGE 544

Name Required Type Default Value Description Mapping configuration in File Store Query Name Required Type Default Value Description persist – – true Whether the Data Record produced will be persisted in Server Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 545

Status Code Content ContentType Add. Headers Description template or resource doesn’t exist / Context not found / Section not found 401 Unauthorized 401 Unauthorized – Error message – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 546

Status Code Content ContentType Add. Headers Description authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 547

Create Preview PDF (By Data) (JSON) Submits a request to create a preview PDF of the print output for a single data record. Request takes a JSON Record Data List of the data values for the Data Record as content, and on success returns a response containing the Managed File ID for the newly created preview PDF file.

PAGE 548

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Managed File ID text/plain – Creation of preview PDF in File Store successful Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 549

Status Code Content ContentType Add. Headers Description 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 550

Request Method Type: POST URI: /rest/serverengine/workflow/contentcreation/imagepreview Content: JSON Image Parameters specifying parameters to be used for content creation Content Type: application/json Add.

PAGE 551

Status Code Content Content-Type Add. Headers Description 200 OK Preview Image image/jpeg – Creation of a preview image successful. Response when the image parameters specified contain: l l 200 OK Preview Image image/png – a type value of JPG or JPEG an archive value and pages value that would result in a single page Creation of a preview image successful.

PAGE 552

Status Code Content Content-Type Add. Headers Description and pages value that would result in a multiple pages Error The following lists status codes indicative of a failed or error response: Status Code Content Content-Type Add. Headers Description 400 Bad Request – – – Context not found / Section not found 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 553

Status Code Content Content-Type Add. Headers Description authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 554

Request Method Type: POST URI: /rest/serverengine/workflow/contentcreation/imagepreview/{templateId} Content: JSON Record Data List (with Image Parameters) of the data values for the Data Record Content Type: application/json Add.

PAGE 555

Status Code Content Content-Type Add. Headers Description 200 OK Preview Image image/jpeg – Creation of a preview image successful. Response when the image parameters specified contain: l l 200 OK Preview Image image/png – a type value of JPG or JPEG an archive value and pages value that would result in a single page Creation of a preview image successful.

PAGE 556

Status Code Content Content-Type Add. Headers Description and pages value that would result in a multiple pages Error The following lists status codes indicative of a failed or error response: Status Code Content Content-Type Add. Headers Description 400 Bad Request – – – Context not found / Section not found 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 557

Status Code Content Content-Type Add. Headers Description authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 558

Get All Operations Returns a list of all the workflow operations actively running on the Server. Request takes no content, and on success returns a response containing a JSON Operations List of all the actively running operations. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/getOperations Content: – Content Type: – Add.

PAGE 559

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 560

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 561

Get Progress of Operation Retrieves the progress of a running Content Creation operation of a specific operation ID. Request takes no content, and on success returns a response containing the current value of operation progress (values ranging from 0 – 100, followed by the value of 'done' on completion). Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/getProgress/{operationId} Content: – Content Type: – Add.

PAGE 562

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Progress value of Content Creation operation text/plain – Progress of operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 563

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 564

Get Result of Operation Retrieves the final result of a completed Content Creation operation of a specific operation ID. Request takes no content, and on success returns a response containing the IDs of the Content Sets produced. Request Method Type: POST URI: /rest/serverengine/workflow/contentcreation/getResult/{operationId} Content: – Content Type: – Add.

PAGE 565

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Content Set IDs text/plain – Result of completed operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 566

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 567

Request Method Type: POST URI: /rest/serverengine/workflow/outputcreation/getManagedResult/ {operationId} Content: – Content Type: – Add.

PAGE 568

Status Code Content ContentType Add. Headers Description 200 OK Managed File ID of the output (file or directory) in the File Store text/plain – Result of completed operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content Content-Type Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 569

Status Code Content Content-Type Add. Headers Description token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 570

Cancel an Operation Requests the cancellation of a running Content Creation operation of a specific operation ID. Request takes no content, and on success returns a response with no content. Request Method Type: POST URI: /rest/serverengine/workflow/contentcreation/cancel/{operationId} Content: – Content Type: – Add.

PAGE 571

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 204 No Content – – – Operation cancellation requested Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 572

Status Code Content ContentType Add. Headers Description token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 573

Service Version Returns the version of the Content Creation service. Request Method Type: GET URI: /rest/serverengine/workflow/contentcreation/version Content: – Content Type: – Add.

PAGE 574

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 575

Content Item Entity Service The following table is a summary of the resources and methods available in the Content Item Entity service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/entity/contentitems GET Get Data Record for Content Item /rest/serverengine/entity/contentitems/ {contentItemId}/datarecord GET Get Content Item Properties /rest/serverengine/entity/contentitems/ {contentItemId}/properties GET Update Content Item Properties /rest/ser

PAGE 576

Get Content Item Properties Returns a list of the properties for a specific Content Item entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the properties for the Content Item. Request Method Type: GET URI: /rest/serverengine/entity/contentitems/{contentItemId}/properties Content: – Content Type: – Add.

PAGE 577

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of properties for Content Item application/json – Content Item entity properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 578

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 579

Get Data Record for Content Item Returns the ID of the corresponding Data Record for a specific Content Item entity. Request takes no content, and on success returns a response containing a JSON Data Record Identifier for the Data Record of the Content Item. Request Method Type: GET URI: /rest/serverengine/entity/contentitems/{contentItemId}/datarecord Content: – Content Type: – Add.

PAGE 580

Status Code Content Content-Type Add. Headers Description 200 OK JSON Data Record Identifier for the Data Record of Content Item application/json – Data Record Identifier returned Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 581

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 582

Service Handshake Queries the availability of the Content Item Entity service. Request Method Type: GET URI: /rest/serverengine/entity/contentitems Content: – Content Type: – Add.

PAGE 583

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 584

Service Version Returns the version of the Content Item Entity service. Request Method Type: GET URI: /rest/serverengine/entity/contentitems/version Content: – Content Type: – Add.

PAGE 585

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 586

Update Content Item Properties Submits a request to update (and replace) the properties for a specific Content Item entity in the Server. Request takes a JSON Name/Value List as content (the Content Item ID and the new properties), and on success returns a response containing the result of the request for update/replacement (“true”).

PAGE 587

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Content Item text/plain – Update of Content Item properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 588

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 589

Update Multiple Content Item Properties Submits a request to update one or more properties for one or more Content Item entities in the Server. Request takes JSON Name/Value Lists as content (each with the Content Item ID and the new properties), and on success returns a response containing no content. Request Method Type: PUT URI: /rest/serverengine/entity/contentitems/properties Content: JSON Name/Value Lists of the properties of the Content Items Content Type: application/json Add.

PAGE 590

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 591

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 592

Content Set Entity Service The following table is a summary of the resources and methods available in the Content Set Entity service: Method Name Uniform Resource Identifier (URI) Method Type "Service Handshake" below /rest/serverengine/entity/contentsets GET Get All Content Sets /rest/serverengine/entity/contentsets GET Get Content Items for Content Set /rest/serverengine/entity/contentsets/ {contentSetId} GET Get Page Details for Content Set /rest/serverengine/entity/contentsets/ {contentSet

PAGE 593

Request Method Type: GET URI: /rest/serverengine/entity/contentsets Content: – Content Type: – Accept: text/plain Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 594

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 595

Delete Content Set Entity Submits a request for a specific Content Set entity to be marked for deletion from the Server. Request takes no content, and on success returns a response containing the result of the request for deletion (“true” or “false”). Request Method Type: POST URI: /rest/serverengine/entity/contentsets/{contentSetId}/delete Content: – Content Type: – Add.

PAGE 596

Status Code Content ContentType Add. Headers Description 200 OK Result of request for Content Set removal text/plain – Deletion of Content Set successfully requested from Server (response of “true” for success or “false” for failure) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 597

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 598

Get All Content Sets Returns a list of all the Content Set entities currently contained within the Server. Request takes no content, and on success returns a response containing a JSON Identifier List of all the Content Sets. Request Method Type: GET URI: /rest/serverengine/entity/contentsets Content: – Content Type: – Add.

PAGE 599

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 600

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 601

Get Content Items for Content Set Returns a list of all the Content Item entities (and their corresponding Data Record entities) contained within a specific Content Set entity. Request takes no content, and on success returns a response containing a JSON Content Item Identifier List of all the Content Items in the Content Set. Request Method Type: GET URI: /rest/serverengine/entity/contentsets/{contentSetId} Content: – Content Type: – Add.

PAGE 602

Response Success The following lists status codes indicative of a successful response: Status Code Content Content-Type Add. Headers Description 200 OK JSON Content Item Identifier List of all the Content Items in Content Set application/json – Content Item Identifier List returned Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 603

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 604

Get Content Set Properties Returns a list of the properties for a specific Content Set entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the properties for the Content Set. Request Method Type: GET URI: /rest/serverengine/entity/contentsets/{contentSetId}/properties Content: – Content Type: – Add.

PAGE 605

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of properties for Content Set application/json – Content Set entity properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 606

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 607

Get Page Details for Content Set Returns the page details for a specific Content Set entity, as either a summary or a list (broken down by Content Item entity).

PAGE 608

Query Name Required Type Default Value Description detail – – False Return a list of details for each Content Item in the Content Set instead of a summary Response Success The following lists status codes indicative of a successful response: Status Code Content Content-Type Add.

PAGE 609

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 610

Service Version Returns the version of the Content Set Entity service. Request Method Type: GET URI: /rest/serverengine/entity/contentsets/version Content: – Content Type: – Add.

PAGE 611

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 612

Update Content Set Properties Submits a request to update (and replace) the properties for a specific Content Set entity in the Server. Request takes a JSON Name/Value List as content (the Content Set ID and the new properties), and on success returns a response containing the result of the request for update/replacement (“true”).

PAGE 613

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Content Set text/plain – Update of Content Set properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 614

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 615

Rasterize File Converts a PDF, PS, AFP or PCL file into a bitmap. The conversion can be done for a single page or for multiple pages. Request takes JSON Bitmap Parameters JSON Bitmap Parameters as content, and on success returns the converted page as a PNG or JPEG file, or returns a ZIP file with the converted images (PNG/JPEG) if rasterization is requested for more than one page.

PAGE 616

Response Success The following lists status codes indicative of a successful response: Status Code Content Content-Type 200 OK A stream with a JPEG/PNG image or a ZIP file with JPEG/PNG images application/zip, image/jpeg, or image/png Add. Headers Description Bitmap creation successful Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 617

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 618

Data Mapping Service The following table is a summary of the resources and methods available in the Data Mapping service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/workflow/datamining GET Create Content Set /rest/serverengine/workflow/datamining/createcontentset/ {dataFileID} POST Process Data Mapping /rest/serverengine/workflow/datamining/{configId}/ {dataFileId} POST Process Data Mapping (JSON) /rest/serverengine/workflow/datamining/{confi

PAGE 619

Method Name Uniform Resource Identifier (URI) Method Type Operation {operationId} Cancel an Operation /rest/serverengine/workflow/datamining/cancel/ {operationId} POST Service Version /rest/serverengine/workflow/datamining/version GET Page 619

PAGE 620

Cancel an Operation Requests the cancellation of a running Data Mapping operation of a specific operation ID. Request takes no content, and on success returns a response with no content. Request Method Type: POST URI: /rest/serverengine/workflow/datamining/cancel/{operationId} Content: – Content Type: – Add.

PAGE 621

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 204 No Content – – – Operation cancellation requested Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 622

Status Code Content ContentType Add. Headers Description token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid. 404 Not Found "JSON Error" on page 37 specifying error message text/plain – Operation not found in Server Create Content Set Submits a request to initiate a new Data Mapping operation.

PAGE 623

Request takes a JSON Identifier (for Content Creation), and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation. Request Method Type: POST URI: /rest/serverengine/workflow/datamining/createcontentset/{dataFileID} Content: "JSON Identifier (for Content Creation)" on page 63 Content Type: application/json Add.

PAGE 624

Status Code Content ContentType 202 Accepted – – Add. Headers l l operationId – Operation ID of new Data Mapping operation Description Creation of new operation successful Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 400 Bad Request – – – Data mapping configuration not made for PDF files.

PAGE 625

Status Code Content ContentType Add. Headers Description 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 626

Get All Operations Returns a list of all the workflow operations actively running on the Server. Request takes no content, and on success returns a response containing a JSON Operations List of all the actively running operations. Request Method Type: GET URI: /rest/serverengine/workflow/datamining/getOperations Content: – Content Type: – Add.

PAGE 627

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 628

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 629

Get Progress of Operation Retrieves the progress of a running Data Mapping operation of a specific operation ID. Request takes no content, and on success returns a response containing the current value of operation progress (values ranging from 0 – 100, followed by the value of 'done' on completion). Request Method Type: GET URI: /rest/serverengine/workflow/datamining/getProgress/{operationId} Content: – Content Type: – Add.

PAGE 630

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Progress value of Data Mapping operation text/plain – Progress of operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 631

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 632

Get Result of Operation Retrieves the final result of a completed Data Mapping operation of a specific operation ID. Request takes no content, and on success returns a response containing the ID of the Data Set produced (or Content Set for a PDF/VT to Content Set specific data mapping operation). Alternatively, if the operation was to only validate the data mapping, then a response containing a JSON Data Mapping Validation Result will be returned instead.

PAGE 633

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Data Set ID (or Content Set ID) text/plain – Result of completed operation successfully retrieved Success (validate) Status Code Content ContentType Add.

PAGE 634

Status Code Content ContentType Add. Headers Description token have been specified in the request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 635

Process Data Mapping Submits a request to initiate a new Data Mapping operation. Request takes no content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation. Request Method Type: POST URI: /rest/serverengine/workflow/datamining/{configId}/{dataFileId} Content: – Content Type: – Add.

PAGE 636

Name Required Type Default Value Description Store Query Name Required Type Default Value Description validate – – false Only validate the Data Mapping operation to check for mapping errors Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add.

PAGE 637

Status Code Content ContentType Add. Headers Description 400 Bad Request – – – Data file or Data Mapping Configuration not found in File Store 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 638

Status Code Content ContentType Add. Headers Description credentials or the authorization token specified in the request headers are invalid. Error (Validate) The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 639

Status Code Content ContentType Add. Headers Description expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 640

Process Data Mapping (JSON) Submits a request to initiate a new Data Mapping operation. Request takes a JSON Identifier (Managed File) of the data file's Managed File ID or Name as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 641

Query Name Required Type Default Value Description validate – – false Only validate the Data Mapping operation to check for mapping errors Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add.

PAGE 642

Status Code Content ContentType Add. Headers Description Configuration not found in File Store 401 Unauthorized 401 Unauthorized – Error message – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 643

Status Code Content ContentType Add. Headers Description specified in the request headers are invalid. 500 Internal Server Error – – – JSON Identifier bad or missing Error (Validate) The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 644

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 645

Process Data Mapping (PDF/VT to Content Set) Submits a request to initiate a new Data Mapping operation using a PDF/VT data file specifically. No Data Mapping configuration or template are specified, and a Content Set will be created based on the default properties extracted from the metadata of the PDF/VT data file.

PAGE 646

Name Required Type Default Value Description Store Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add.

PAGE 647

Status Code 401 Unauthorized Content Error message ContentType – Add. Headers Description Authenticate – BASIC (Basic Authentication credentials are accepted) required. – Server authentication has failed. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed.

PAGE 648

Process Data Mapping (PDF/VT to Data Set) Submits a request to initiate a new Data Mapping operation using a PDF/VT data file specifically. No Data Mapping configuration is specified, and a Data Set will be created based on the default properties extracted from the metadata of the PDF/VT data file.

PAGE 649

Name Required Type Default Value Description Store Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add.

PAGE 650

Status Code 401 Unauthorized Content Error message ContentType – Add. Headers Description Authenticate – BASIC (Basic Authentication credentials are accepted) required. – Server authentication has failed. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed.

PAGE 651

Service Handshake Queries the availability of the Data Mapping service. Request Method Type: GET URI: /rest/serverengine/workflow/datamining Content: – Content Type: – Add.

PAGE 652

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 653

Service Version Returns the version of the Data Mapping service. Request Method Type: GET URI: /rest/serverengine/workflow/datamining/version Content: – Content Type: – Add.

PAGE 654

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 655

Data Record Entity Service The following table is a summary of the resources and methods available in the Data Record Entity service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/entity/datarecords GET Add Data Records /rest/serverengine/entity/datarecords POST Get Data Record Values /rest/serverengine/entity/datarecords/ {dataRecordId}/values GET Update Data Record Values /rest/serverengine/entity/datarecords/ {dataRecordId}/values PUT Get D

PAGE 656

Add Data Records Submits a request to add one or more Data Record entities to one or more entities in the Server as either: l a Data Record of an existing Data Set entity in the Server, or l a nested Data Record in a Data Table of an existing Data Record entity in the Server Request takes JSON New Record Lists as content (each with the Data Set/Data Record ID, Data Table and the new records/values), and on success returns a response containing no content.

PAGE 657

Status Code Content ContentType Add. Headers Description 200 OK – – – Data Records for Data Set/Data Record entities successfully added Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 658

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 659

Get Data Record Properties Returns a list of the properties for a specific Data Record entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the properties for the Data Record. Request Method Type: GET URI: /rest/serverengine/entity/datarecords/{dataRecordId}/properties Content: – Content Type: – Add.

PAGE 660

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of properties for Data Record application/json – Data Record entity properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 661

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 662

Get Data Record Values Returns a list of the values for a specific Data Record entity, and potentially the values of any nested Data Records (if recursive).

PAGE 663

Query Name Required Type Default Value Description recursive – – False Recurse all Data Tables within the Data Record and retrieve the values of any nested Data Records explicitTypes – – False Retrieve both values and data types of the Data Record Response Success The following lists status codes indicative of a successful response: Status Code Content Content-Type Add.

PAGE 664

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 665

Status Code Content ContentType Add.

PAGE 666

Get Multiple Data Record Values Returns a list of the values for one or more Data Record entities, and potentially the values of any nested Data Records (if recursive). Request takes no content, and on success returns a response containing JSON Record Content Lists of all the values for each Data Record. Request Method Type: GET URI: /rest/serverengine/entity/datarecords/values Content: – Content Type: – Add.

PAGE 667

Name Required Type Default Value Description Records Response Success The following lists status codes indicative of a successful response: Status Code Content Content-Type Add. Headers Description 200 OK JSON Record Content Lists of the values for each Data Record application/json – Data Record entity values successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 668

Status Code Content ContentType Add. Headers Description 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 669

Get Multiple Data Record Values (JSON) Returns a list of the values for one or more Data Record entities, and potentially the values of any nested Data Records (if recursive).

PAGE 670

Status Code Content Content-Type Add.

PAGE 671

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 672

Service Handshake Queries the availability of the Data Record Entity service. Request Method Type: GET URI: /rest/serverengine/entity/datarecords Content: – Content Type: – Add.

PAGE 673

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 674

Service Version Returns the version of the Data Record Entity service. Request Method Type: GET URI: /rest/serverengine/entity/datarecords/version Content: – Content Type: – Add.

PAGE 675

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 676

Update Data Record Properties Submits a request to update (and replace) the properties for a specific Data Record entity in the Server. Request takes a JSON Name/Value List as content (the Data Record ID and the new properties), and on success returns a response containing the result of the request for update/replacement (“true”).

PAGE 677

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Data Record text/plain – Update of Data Record properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 678

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 679

Update Data Record Values Submits a request to update one or more values for a specific Data Record entity in the Server. Request takes a JSON Record Content List (Fields Only) as content (the Data Record ID and the new values), and on success returns a response containing no content. Request Method Type: PUT URI: /rest/serverengine/entity/datarecords/{dataRecordId}/values Content: JSON Record Content List (Fields Only) of the values for Data Record Content Type: application/json Add.

PAGE 680

Status Code Content ContentType Add. Headers Description 200 OK – – – Data Record entity values successfully updated Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 681

Status Code Content ContentType Add. Headers message Description authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 682

Update Multiple Data Record Properties Submits a request to update one or more properties for one or more Data Record entities in the Server. Request takes JSON Name/Value Lists as content (each with the Data Record ID and the new properties), and on success returns a response containing no content. Request Method Type: PUT URI: /rest/serverengine/entity/datarecords/properties Content: JSON Name/Value Lists of the properties of the Data Records Content Type: application/json Add.

PAGE 683

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 684

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 685

Update Multiple Data Record Values Submits a request to update one or more values for one or more Data Record entities in the Server. Request takes JSON Record Content Lists (Fields Only) as content (each with the Data Record ID and the new values), and on success returns a response containing no content. Request Method Type: PUT URI: /rest/serverengine/entity/datarecords Content: JSON Record Content Lists (Fields Only) of the values for the Data Records Content Type: application/json Add.

PAGE 686

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 687

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 688

Data Set Entity Service The following table is a summary of the resources and methods available in the Data Set Entity service: Method Name Uniform Resource Identifier (URI) Method Type "Service Handshake" below /rest/serverengine/entity/datasets GET Get All Data Sets /rest/serverengine/entity/datasets GET Get Data Records for Data Set /rest/serverengine/entity/datasets/{dataSetId} GET Delete Data Set Entity /rest/serverengine/entity/datasets/ {dataSetId}/delete POST Get Data Set Properties

PAGE 689

Content: – Content Type: – Accept: text/plain Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 690

Status Code 401 Unauthorized Content Error message ContentType – Add. Headers Description Authentication credentials are accepted) Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed.

PAGE 691

Delete Data Set Entity Submits a request for a specific Data Set entity to be marked for deletion from the Server. Request takes no content, and on success returns a response containing the result of the request for deletion (“true” or “false”). Request Method Type: POST URI: /rest/serverengine/entity/datasets/{dataSetId}/delete Content: – Content Type: – Add.

PAGE 692

Status Code Content ContentType Add. Headers Description 200 OK Result of request for Data Set removal text/plain – Deletion of Data Set successfully requested from Server (response of “true” for success or “false” for failure) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 693

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 694

Get All Data Sets Returns a list of all the Data Set entities currently contained within the Server. Request takes no content, and on success returns a response containing a JSON Identifier List of all the Data Sets. Request Method Type: GET URI: /rest/serverengine/entity/datasets Content: – Content Type: – Add.

PAGE 695

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 696

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 697

Get Data Records for Data Set Returns a list of all the Data Record entities contained within a specific Data Set entity. Request takes no content, and on success returns a response containing a JSON Identifier List of all the Data Records in the Data Set. Request Method Type: GET URI: /rest/serverengine/entity/datasets/{dataSetId} Content: – Content Type: – Add.

PAGE 698

Status Code Content Content-Type Add. Headers Description 200 OK JSON Identifier List of all the Data Records in Data Set application/json – Identifier List of Data Records returned Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 699

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 700

Get Data Set Properties Returns a list of the properties for a specific Data Set entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the properties for the Data Set. Request Method Type: GET URI: /rest/serverengine/entity/datasets/{dataSetId}/properties Content: – Content Type: – Add.

PAGE 701

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of properties for Data Set application/json – Data Set entity properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 702

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 703

Service Version Returns the version of the Data Set Entity service. Request Method Type: GET URI: /rest/serverengine/entity/datasets/version Content: – Content Type: – Add.

PAGE 704

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 705

Update Data Set Properties Submits a request to update (and replace) the properties for a specific Data Set entity in the Server. Request takes a JSON Name/Value List as content (the Data Set ID and the new properties), and on success returns a response containing the result of the request for update/replacement (“true”). Request Method Type: PUT URI: /rest/serverengine/entity/datasets/{dataSetId}/properties Content: JSON Name/Value List of properties for Data Set Content Type: application/json Add.

PAGE 706

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Data Set text/plain – Update of Data Set properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 707

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 708

Document Entity Service The following table is a summary of the resources and methods available in the Document Entity service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/entity/documents GET Get Document Metadata Properties /rest/serverengine/entity/documents/ {documentId}/metadata GET Update Document Metadata Properties /rest/serverengine/entity/documents/ {documentId}/metadata PUT Service Version /rest/serverengine/entity/documents/version

PAGE 709

Get Document Metadata Properties Returns a list of the metadata properties for a specific Document entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the metadata properties for the Document. Request Method Type: GET URI: /rest/serverengine/entity/documents/{documentId}/metadata Content: – Content Type: – Add.

PAGE 710

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of metadata properties for Document application/json – Document entity metadata properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 711

Status Code Content ContentType Add. Headers Description expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 712

Service Handshake Queries the availability of the Document Entity service. Request Method Type: GET URI: /rest/serverengine/entity/documents Content: – Content Type: – Add.

PAGE 713

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 714

Service Version Returns the version of the Document Entity service. Request Method Type: GET URI: /rest/serverengine/entity/documents/version Content: – Content Type: – Add.

PAGE 715

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 716

Update Document Metadata Properties Submits a request to update (and replace) the metadata properties for a specific Document entity in the Server. Request takes a JSON Name/Value List as content (the Document ID and the new metadata properties), and on success returns a response containing the result of the request for update/replacement (“true”).

PAGE 717

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Document text/plain – Update of Document metadata properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 718

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 719

Document Set Entity Service The following table is a summary of the resources and methods available in the Document Set Entity service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/entity/documentsets GET Get Documents for Document Set /rest/serverengine/entity/documentsets/ {documentSetId} GET Get Document Set Metadata Properties /rest/serverengine/entity/documentsets/ {documentSetId}/metadata GET Update Document Set Metadata Properties /rest/

PAGE 720

Get Document Set Metadata Properties Returns a list of the metadata properties for a specific Document Set entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the metadata properties for the Document Set. Request Method Type: GET URI: /rest/serverengine/entity/documentsets/{documentSetId}/metadata Content: – Content Type: – Add.

PAGE 721

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of metadata properties for Document Set application/json – Document Set entity metadata properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 722

Status Code Content ContentType Add. Headers Description expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 723

Get Documents for Document Set Returns a list of all the Document entities contained within a specific Document Set entity. Request takes no content, and on success returns a response containing a JSON Identifier List of all the Documents in the Document Set. Request Method Type: GET URI: /rest/serverengine/entity/documentsets/{documentSetId} Content: – Content Type: – Add.

PAGE 724

Status Code Content Content-Type Add. Headers Description 200 OK JSON Identifier List of all the Documents in Document Set application/json – Identifier List of Documents returned Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 725

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 726

Service Handshake Queries the availability of the Document Set Entity service. Request Method Type: GET URI: /rest/serverengine/entity/documentsets Content: – Content Type: – Add.

PAGE 727

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 728

Service Version Returns the version of the Document Set Entity service. Request Method Type: GET URI: /rest/serverengine/entity/documentsets/version Content: – Content Type: – Add.

PAGE 729

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 730

Update Document Set Metadata Properties Submits a request to update (and replace) the metadata properties for a specific Document Set entity in the Server. Request takes a JSON Name/Value List as content (the Document Set ID and the new metadata properties), and on success returns a response containing the result of the request for update/replacement (“true”).

PAGE 731

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Document Set text/plain – Update of Document Set metadata properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 732

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 733

Entity Service The following table is a summary of the resources and methods available in the Entity service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/entity GET Find Data Entity /rest/serverengine/entity/find PUT Service Version /rest/serverengine/entity/version GET Page 733

PAGE 734

Find Data Entity Submits data entity search criteria to the PlanetPress Connect Server. Request takes a JSON Search Parameters structure as content and on success returns a response containing JSON Identifier Lists (with Sort Key) of the data entity IDs matching the search criteria. Method Type: PUT URI: /rest/serverengine/entity/find Content: JSON Search Parameters containing search criteria/rules Content Type: application/json Add.

PAGE 735

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 736

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 737

Service Handshake Queries the availability of the Entity service. Request Method Type: GET URI: /rest/serverengine/entity Content: – Content Type: – Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 738

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 739

Service Version Returns the version of the Entity service. Request Method Type: GET URI: /rest/serverengine/entity/version Content: – Content Type: – Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 740

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 741

File Store Service The following table is a summary of the resources and methods available in the File Store service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/filestore GET "Managed File or Directory Exists" on page 762 /rest/serverengine/filestore/file/{fileId} HEAD Download Managed File or Directory /rest/serverengine/filestore/file/{fileId} GET "Download Contents of Managed Directory" on page 747 /rest/serverengine/filestore/file/{fileId

PAGE 742

Method Name Uniform Resource Identifier (URI) Method Type Service Version /rest/serverengine/filestore/version GET Page 742

PAGE 743

Service Handshake Queries the availability of the File Store service. Request Method Type: GET URI: /rest/serverengine/filestore Content: – Content Type: – Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 744

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 745

Download Managed File or Directory Obtains an existing file or directory of a specific Managed File ID (or Name) from the File Store. Request takes no content, and on success returns a response containing the file or directory data (as zipped file). Request Method Type: GET URI: /rest/serverengine/filestore/file/{fileId} Content: – Content Type: – Add.

PAGE 746

Status Code Content Content-Type Add. Headers Description 200 OK File application/octetstream ContentDisposition – Filename of the Managed File File successfully downloaded from File Store. Example: "attachment; filename=PromoEN.OL-datamapper" 200 OK Directory (zipped) application/zip ContentDisposition – Filename of the Managed Directory Directory successfully downloaded from File Store. Example: "attachment; filename=letterol.

PAGE 747

Status Code Content ContentType Add. Headers Description authorization token have been specified in the request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 748

Request takes no content, and on success returns a response containing the file or directory data (as zipped file). Request Method Type: GET URI: /rest/serverengine/filestore/file/{fileId}/{relPath: .+} Content: – Content Type: – Add.

PAGE 749

Query Name Required Type Default Value Description output No String – The output method to be used for the file Response Success The following lists status codes indicative of a successful response: Status Code Content Content-Type Add. Headers Description 200 OK File application/octetstream Content-Disposition – Filename of the specific file within directory File successfully downloaded from File Store E.g. "attachment; filename=pps-box.

PAGE 750

Status Code Content Content-Type Add. Headers Description 200 OK Directory (Zipped) application/zip Content-Disposition – File name of the specific directory (zipped) within directory Directory successfully downloaded from File Store. E.g. "attachment; filename=images.zip" Error The following lists status codes indicative of a failed or error response: Status Code Content Content-Type Add.

PAGE 751

Status Code Content Content-Type Add. Headers Description when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid. 404 Not Found "JSON Error" on page 37 specifying error message application/json – Directory not found in File Store.

PAGE 752

Delete Managed File or Directory Removes an existing file or directory of a specific Managed File ID (or Name) from the File Store. Request takes no content, and on success returns a response containing the result of the request for removal. Request Method Type: GET URI: /rest/serverengine/filestore/delete/{fileId} Content: – Content Type: – Add.

PAGE 753

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Result of request for removal text/plain – Removal of file or directory successfully requested from File Store Error The following lists status codes indicative of a failed or error response: Status Code Content Content-Type 400 Bad Request "JSON Error" on page 37 specifying error message application/json 401 Unauthorized – – Add.

PAGE 754

Status Code Content Content-Type Add. Headers Description headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 755

Status Code Content Content-Type 500 Internal Server Error "JSON Error" on page 37 specifying error message application/json Add. Headers Description Connection refused Get Report Returns a report in JSON or XML of a template in the File Store. The report contains the tags specified in the filter, or all tags if no filter was specified. Request takes no content, and on success returns a response containing a JSON or XML structure that holds information about the Connect template.

PAGE 756

Parameters Path Name Required Type fileId – – Name Required Type filter – – Default Value Description The Managed File ID (or Name) of the template in the File Store. Query Default Value Description A valid tag name (case sensitive). Examples: sections, media, scripts, datamodel, properties, locale.

PAGE 757

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers 400 Bad Request 401 Unauthorized 401 Unauthorized Description Filter is invalid. – Error message – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 758

Status Code Content ContentType Add. Headers Description either the basic authentication credentials or the authorization token specified in the request headers are invalid. 404 Not Found – 406 Not Acceptable – – Template not found in File Store. None of the content types are supported by the server.

PAGE 759

URI: /rest/serverengine/filestore/resources Content: – Content Type: – Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Parameters Path Name Required Type Default Value Description type – – If the type parameter is omitted the endpoint will return: The type or types (comma-separated) of the files to list.

PAGE 760

Name Required Type Default Value Description CREATION_ CONFIG: Output creation presets l DATA_FILE: Data files Response Success The following lists status codes indicative of a successful response: Status Code Content Content-Type 200 OK A JSON structure that has an array of objects holding base information on Connect resources: application/json l id (integer) l name (string) l path (string) l type (string) l size (integer) Add. Headers Description List returned.

PAGE 761

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 762

Status Code Content ContentType Add. Headers Description 404 Not Found – – – No resources of the specified type found in File Store. Managed File or Directory Exists Checks whether a file or directory of a specific Managed File ID (or Name) exists in the File Store. Request Method Type: HEAD URI: /rest/serverengine/filestore/file/{fileId} Content: – Content Type: – Add.

PAGE 763

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers 200 OK Description File or directory exists in the File Store. Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 764

Status Code Content ContentType Add. Headers Description the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 765

Upload Data File Submits a data file to the File Store. Request takes binary file data as content, and on success returns a response containing the new Managed File ID for the data file. Request Method Type: POST URI: /rest/serverengine/filestore/DataFile Content: Data File (File) Content Type: application/octet-stream Add.

PAGE 766

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Managed File ID (or Name) text/plain – Data file successfully uploaded to File Store Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 767

Status Code Content ContentType Add. Headers Description the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 768

Upload Data Mapping Configuration Submits a Data Mapping configuration to the File Store. Request takes binary file data as content, and on success returns a response containing the new Managed File ID for the configuration. Request Method Type: POST URI: /rest/serverengine/filestore/DataMiningConfig Content: Data Mapping Configuration (File) Content Type: application/octet-stream Add.

PAGE 769

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Managed File ID (or Name) text/plain – Configuration successfully uploaded to File Store Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers 400 Bad Request 401 Unauthorized 401 Unauthorized Description Request contains no data for upload to File Store.

PAGE 770

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 771

Upload Template Submits a template to the File Store. Request takes zipped file data as content, and on success returns a response containing the new Managed File ID for the template. Request Method Type: POST URI: /rest/serverengine/filestore/template Content: Template (File) Content Type: application/zip Add.

PAGE 772

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Managed File ID (or Name) text/plain – Template successfully uploaded to File Store Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers 400 Bad Request 401 Unauthorized 401 Unauthorized Description Request contains no data for upload to File Store.

PAGE 773

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 774

Upload Job Creation Preset Submits a Job Creation preset to the File Store. Request takes XML file data as content, and on success returns a response containing the new Managed File ID for the preset. Request Method Type: POST URI: /rest/serverengine/filestore/JobCreationConfig Content: Job Creation Preset (File) Content Type: application/xml Add.

PAGE 775

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Managed File ID (or Name) text/plain – Preset successfully uploaded to File Store Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers 400 Bad Request 401 Unauthorized 401 Unauthorized Description Request contains no data for upload to File Store.

PAGE 776

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 777

Upload Output Creation Preset Submits an Output Creation preset to the File Store. Request takes XML file data as content, and on success returns a response containing the new Managed File ID for the preset. Request Method Type: POST URI: /rest/serverengine/filestore/OutputCreationConfig Content: Output Creation Preset (File) Content Type: application/xml Add.

PAGE 778

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Managed File ID (or Name) text/plain – Preset successfully uploaded to File Store Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers 400 Bad Request 401 Unauthorized 401 Unauthorized Description Request contains no data for upload to File Store.

PAGE 779

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 780

Service Version Returns the version of the File Store service. Request Method Type: GET URI: /rest/serverengine/filestore/version Content: – Content Type: – Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 781

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 782

Job Creation Service The following table is a summary of the resources and methods available in the Job Creation service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/workflow/jobcreation GET Process Job Creation /rest/serverengine/workflow/jobcreation/{configId} POST "Process Job Creation (By Content Set) (JSON)" on page 799 /rest/serverengine/workflow/jobcreation/{configId} POST "Process Job Creation (By Content Set) (Runtime Parameters) (JSON

PAGE 783

Method Name Uniform Resource Identifier (URI) Method Type Get Result of Operation /rest/serverengine/workflow/jobcreation/getResult/ {operationId} POST Cancel an Operation /rest/serverengine/workflow/jobcreation/cancel/ {operationId} POST Service Version /rest/serverengine/workflow/jobcreation/version GET Page 783

PAGE 784

Cancel an Operation Requests the cancellation of a running Job Creation operation of a specific operation ID. Request takes no content, and on success returns a response with no content. Request Method Type: POST URI: /rest/serverengine/workflow/jobcreation/cancel/{operationId} Content: – Content Type: – Add.

PAGE 785

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 204 No Content – – – Operation cancellation requested Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 786

Status Code Content ContentType Add. Headers Description token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 787

Get All Operations Returns a list of all the workflow operations actively running on the Server. Request takes no content, and on success returns a response containing a JSON Operations List of all the actively running operations. Request Method Type: GET URI: /rest/serverengine/workflow/jobcreation/getOperations Content: – Content Type: – Add.

PAGE 788

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 789

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 790

Get Progress of Operation Retrieves the progress of a running Job Creation operation of a specific operation ID. Request takes no content, and on success returns a response containing the current value of operation progress (values ranging from 0 – 100, followed by the value of 'done' on completion). Request Method Type: GET URI: /rest/serverengine/workflow/jobcreation/getProgress/{operationId} Content: – Content Type: – Add.

PAGE 791

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Progress value of Job Creation operation text/plain – Progress of operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 792

Status Code Content ContentType Add. Headers Description the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 793

Get Result of Operation Retrieves the final result of a completed Job Creation operation of a specific operation ID. Request takes no content, and on success returns a response containing the ID of the Job Set produced. Request Method Type: POST URI: /rest/serverengine/workflow/jobcreation/getResult/{operationId} Content: – Content Type: – Add.

PAGE 794

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Job Set ID text/plain – Result of completed operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 795

Status Code Content ContentType Add. Headers Description the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 796

Process Job Creation Submits a request to initiate a new Job Creation operation. Request takes no content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation. Request Method Type: POST URI: /rest/serverengine/workflow/jobcreation/{configId} Content: – Content Type: – Add.

PAGE 797

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add. Headers l l operationId – Operation ID of new Job Creation operation Description Creation of new operation successful Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 798

Status Code Content ContentType Add. Headers Description request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 799

Process Job Creation (By Content Set) (JSON) Submits a request to initiate a new Job Creation operation. Request takes a JSON Identifier List of Content Set IDs as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 800

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add. Headers l l operationId – Operation ID of new Job Creation operation Description Creation of new operation successful Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 801

Status Code Content ContentType Add. Headers Description request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 802

Request takes a JSON Identifier List (with Runtime Parameters) of Content Set IDs and parameters as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 803

Status Code Content ContentType 202 Accepted – – Add. Headers l l operationId – Operation ID of new Job Creation operation Description Creation of new operation successful Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 804

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 805

Process Job Creation (By Job Set Structure) (JSON) Submits a request to initiate a new Job Creation operation. Request takes a JSON Job Set Structure containing a list of Content Items as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 806

Status Code Content ContentType Add. Headers Description operation l Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 807

Status Code Content ContentType Add. Headers Description token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 808

Service Handshake Queries the availability of the Job Creation service. Request Method Type: GET URI: /rest/serverengine/workflow/jobcreation Content: – Content Type: – Add.

PAGE 809

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 810

Service Version Returns the version of the Job Creation service. Request Method Type: GET URI: /rest/serverengine/workflow/jobcreation/version Content: – Content Type: – Add.

PAGE 811

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 812

Job Entity Service The following table is a summary of the resources and methods available in the Job Entity service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/entity/jobs GET Get Content Items for Job /rest/serverengine/entity/jobs/ {jobId}/contents GET Get Job Segments for Job /rest/serverengine/entity/jobs/{jobId} GET Get Job Metadata Properties /rest/serverengine/entity/jobs/ {jobId}/metadata GET Update Job Metadata Properties /rest/s

PAGE 813

Get Content Items for Job Returns a list of all the Content Item entities (and their corresponding Data Record entities) contained within a specific Job entity. Request takes no content, and on success returns a response containing a JSON Content Item Identifier List of all the Content Items for the Job. Request Method Type: GET URI: /rest/serverengine/entity/jobs/{jobId}/contents Content: – Content Type: – Add.

PAGE 814

Status Code Content Content-Type Add. Headers Description 200 OK JSON Content Item Identifier List of all the Content Items in Job application/json – Content Item Identifier List returned Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 815

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 816

Get Job Metadata Properties Returns a list of the metadata properties for a specific Job entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the metadata properties for the Job. Request Method Type: GET URI: /rest/serverengine/entity/jobs/{jobId}/metadata Content: – Content Type: – Add.

PAGE 817

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of metadata properties for Job application/json – Job entity metadata properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 818

Status Code Content ContentType Add. Headers Description expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 819

Get Job Properties Returns a list of the properties for a specific Job entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the properties for the Job. Request Method Type: GET URI: /rest/serverengine/entity/jobs/{jobId}/properties Content: – Content Type: – Add.

PAGE 820

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of properties for Job application/json – Job entity properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 821

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 822

Get Job Segments for Job Returns a list of all the Job Segment entities contained within a specific Job entity. Request takes no content, and on success returns a response containing a JSON Identifier List of all the Job Segments in the Job. Request Method Type: GET URI: /rest/serverengine/entity/jobs/{jobId} Content: – Content Type: – Add.

PAGE 823

Status Code Content Content-Type Add. Headers Description 200 OK JSON Identifier List of all the Job Segments in Job application/json – Identifier List of Job Segments returned Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 824

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 825

Service Handshake Queries the availability of the Job Entity service. Request Method Type: GET URI: /rest/serverengine/entity/jobs Content: – Content Type: – Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 826

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 827

Service Version Returns the version of the Job Entity service. Request Method Type: GET URI: /rest/serverengine/entity/jobs/version Content: – Content Type: – Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 828

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 829

Update Job Metadata Properties Submits a request to update (and replace) the metadata properties for a specific Job entity in the Server. Request takes a JSON Name/Value List as content (the Job ID and the new metadata properties), and on success returns a response containing the result of the request for update/replacement (“true”).

PAGE 830

Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Job text/plain – Update of Job metadata properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 831

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 832

Update Job Properties Submits a request to update (and replace) the properties for a specific Job entity in the Server. Request takes a JSON Name/Value List as content (the Job ID and the new properties), and on success returns a response containing the result of the request for update/replacement (“true”). Request Method Type: PUT URI: /rest/serverengine/entity/jobs/{jobId}/properties Content: JSON Name/Value List of properties for Job Content Type: application/json Add.

PAGE 833

Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Job text/plain – Update of Job properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 834

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 835

Update Multiple Job Properties Submits a request to update one or more properties for one or more Job entities in the Server. Request takes JSON Name/Value Lists as content (each with the Job ID and the new properties), and on success returns a response containing no content. Request Method Type: PUT URI: /rest/serverengine/entity/jobs/properties Content: JSON Name/Value List of the properties of the Jobs Content Type: application/json Add.

PAGE 836

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 837

Job Segment Entity Service The following table is a summary of the resources and methods available in the Job Segment Entity service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/entity/jobsegments GET Get Document Sets for Job Segment /rest/serverengine/entity/jobsegments/ {jobSegmentId} GET Get Job Segment Metadata Properties /rest/serverengine/entity/jobsegments/ {jobSegmentId}/metadata GET Update Job Segment Metadata Properties /rest/server

PAGE 838

Get Document Sets for Job Segment Returns a list of all the Document Set entities contained within a specific Job Segment entity. Request takes no content, and on success returns a response containing a JSON Identifier List of all the Document Sets in the Job Segment. Request Method Type: GET URI: /rest/serverengine/entity/jobsegments/{jobSegmentId} Content: – Content Type: – Add.

PAGE 839

Status Code Content Content-Type Add. Headers Description 200 OK JSON Identifier List of all the Document Sets in Job Segment application/json – Identifier List of Document Sets returned Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 840

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 841

Get Job Segment Metadata Properties Returns a list of the metadata properties for a specific Job Segment entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the metadata properties for the Job Segment. Request Method Type: GET URI: /rest/serverengine/entity/jobsegments/{jobSegmentId}/metadata Content: – Content Type: – Add.

PAGE 842

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of metadata properties for Job Segment application/json – Job Segment entity metadata properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 843

Status Code Content ContentType Add. Headers Description expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 844

Service Handshake Queries the availability of the Job Segment Entity service. Request Method Type: GET URI: /rest/serverengine/entity/jobsegments Content: – Content Type: – Add.

PAGE 845

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 846

Service Version Returns the version of the Job Segment Entity service. Request Method Type: GET URI: /rest/serverengine/entity/jobsegments/version Content: – Content Type: – Add.

PAGE 847

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 848

Update Job Segment Metadata Properties Submits a request to update (and replace) the metadata properties for a specific Job Segment entity in the Server. Request takes a JSON Name/Value List as content (the Job Segment ID and the new metadata properties), and on success returns a response containing the result of the request for update/replacement (“true”).

PAGE 849

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Job Segment text/plain – Update of Job Segment metadata properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 850

Status Code Content ContentType Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 851

Job Set Entity Service The following table is a summary of the resources and methods available in the Job Set Entity service: Method Name Uniform Resource Identifier (URI) Method Type "Service Handshake" below /rest/serverengine/entity/jobsets GET Get All Job Sets /rest/serverengine/entity/jobsets GET Get Jobs for Job Set /rest/serverengine/entity/jobsets/{jobSetId} GET Delete Job Set Entity /rest/serverengine/entity/jobsets/ {jobSetId}/delete POST Get Job Set Metadata Properties /rest/serv

PAGE 852

Request Method Type: GET URI: /rest/serverengine/entity/jobsets Content: – Content Type: – Accept: text/plain Add. Headers: If server security settings are enabled, then one of the following: l l Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) auth_token – Authorization Token Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add.

PAGE 853

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 854

Delete Job Set Entity Submits a request for a specific Job Set entity to be marked for deletion from the Server. Request takes no content, and on success returns a response containing the result of the request for deletion (“true” or “false”). Request Method Type: POST URI: /rest/serverengine/entity/jobsets/{jobSetId}/delete Content: – Content Type: – Add.

PAGE 855

Status Code Content ContentType Add. Headers Description 200 OK Result of request for Job Set removal text/plain – Deletion of Job Set successfully requested from Server (response of “true” for success or “false” for failure) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 856

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 857

Get All Job Sets Returns a list of all the Job Set entities currently contained within the Server. Request takes no content, and on success returns a response containing a JSON Identifier List of all the Job Sets. Request Method Type: GET URI: /rest/serverengine/entity/jobsets Content: – Content Type: – Add.

PAGE 858

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 859

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 860

Get Job Set Metadata Properties Returns a list of the metadata properties for a specific Job Set entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the metadata properties for the Job Set. Request Method Type: GET URI: /rest/serverengine/entity/jobsets/{jobSetId}/metadata Content: – Content Type: – Add.

PAGE 861

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of metadata properties for Job Set application/json – Job Set entity metadata properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 862

Status Code Content ContentType Add. Headers Description expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 863

Get Job Set Properties Returns a list of the properties for a specific Job Set entity. Request takes no content, and on success returns a response containing a JSON Name/Value List (Properties Only) of all the properties for the Job Set. Request Method Type: GET URI: /rest/serverengine/entity/jobsets/{jobSetId}/properties Content: – Content Type: – Add.

PAGE 864

Status Code Content Content-Type Add. Headers Description 200 OK JSON Name/Value List (Properties Only) of properties for Job Set application/json – Job Set entity properties successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 865

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 866

Get Jobs for Job Set Returns a list of all the Job entities contained within a specific Job Set entity. Request takes no content, and on success returns a response containing a JSON Identifier List of all the Jobs in the Job Set. Request Method Type: GET URI: /rest/serverengine/entity/jobsets/{jobSetId} Content: – Content Type: – Add.

PAGE 867

Status Code Content Content-Type Add. Headers Description 200 OK JSON Identifier List of all the Jobs in Job Set application/json – Identifier List of Jobs returned Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed.

PAGE 868

Status Code Content ContentType Add. Headers Description 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 869

Service Version Returns the version of the Job Set Entity service. Request Method Type: GET URI: /rest/serverengine/entity/jobsets/version Content: – Content Type: – Add.

PAGE 870

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 871

Update Job Set Metadata Properties Submits a request to update (and replace) the metadata properties for a specific Job Set entity in the Server. Request takes a JSON Name/Value List as content (the Job Set ID and the new metadata properties), and on success returns a response containing the result of the request for update/replacement (“true”).

PAGE 872

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Job Set text/plain – Update of Job Set metadata properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 873

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 874

Update Job Set Properties Submits a request to update (and replace) the properties for a specific Job Set entity in the Server. Request takes a JSON Name/Value List as content (the Job Set ID and the new properties), and on success returns a response containing the result of the request for update/replacement (“true”). Request Method Type: PUT URI: /rest/serverengine/entity/jobsets/{jobSetId}/properties Content: JSON Name/Value List of properties for Job Set Content Type: application/json Add.

PAGE 875

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Result of request to update Job Set text/plain – Update of Job Set properties successfully requested (response of “true” for success) Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 876

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 877

Output Creation Service The following table is a summary of the resources and methods available in the Output Creation service: Method Name Uniform Resource Identifier (URI) Method Type Service Handshake /rest/serverengine/workflow/outputcreation GET "Process Output Creation (By Job Set)" on page 881 /rest/serverengine/workflow/outputcreation/{configId}/ {jobSetId} POST "Process Output Creation (By Job Set) (JSON)" on page 884 /rest/serverengine/workflow/outputcreation/{configId} POST Process O

PAGE 878

Method Name Uniform Resource Identifier (URI) Method Type Operation {operationId} Get Result of Operation (as Text) /rest/serverengine/workflow/outputcreation/getResultTxt/ {operationId} POST Cancel an Operation /rest/serverengine/workflow/outputcreation/cancel/ {operationId} POST Service Version /rest/serverengine/workflow/outputcreation/version GET Page 878

PAGE 879

Service Handshake Queries the availability of the Output Creation service. Request Method Type: GET URI: /rest/serverengine/workflow/outputcreation Content: – Content Type: – Add.

PAGE 880

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 881

Process Output Creation (By Job Set) Submits a request to initiate a new Output Creation operation. Request takes no content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation. Request Method Type: POST URI: /rest/serverengine/workflow/outputcreation/{configId}/{jobSetId} Content: – Content Type: – Add.

PAGE 882

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add. Headers l l operationId – Operation ID of new Output Creation operation Description Creation of new operation successful Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 883

Status Code Content ContentType Add. Headers Description request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 884

Process Output Creation (By Job Set) (JSON) Submits a request to initiate a new Output Creation operation. Request takes a JSON Identifier (with Output Parameters) of the Job Set ID as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 885

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add. Headers l l operationId – Operation ID of new Output Creation operation Description Creation of new operation successful Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 886

Status Code Content ContentType Add. Headers Description request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 887

Process Output Creation (By Job) (JSON) Submits a request to initiate a new Output Creation operation. Request takes a JSON Identifier List (with Output Parameters) of the Job IDs as content, and on success returns a response containing additional headers that specify the ID of the new operation as well as link URLs that can be used to retrieve further information/cancel the operation.

PAGE 888

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType 202 Accepted – – Add. Headers l l operationId – Operation ID of new Output Creation operation Description Creation of new operation successful Link – Contains multiple link URLs that can be used to retrieve further information/cancel the operation Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 889

Status Code Content ContentType Add. Headers Description request headers. 401 Unauthorized Error message – – Server authentication has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 890

Run +PReS Enhance Workflow Configuration Submits a request to run a +PReS Enhance workflow configuration via the Weaver engine directly, using a list of command-line arguments. Request takes no content, and on success returns a response containing the result of the request to run/execute the workflow configuration. Request Method Type: GET URI: /rest/serverengine/workflow/outputcreation/execute/{args}/{size} Content: – Content Type: – Add.

PAGE 891

Name Required Type Default Value Description +PReS Enhance workflow configuration l l size – – -O,

– the path to directory to be used for output – the path(s) to the file(s) to be used as input The estimated page size, used by PlanetPress Connect to determine the job size (which determines the number of speed units to use) – 1 For a list of all the available command-line arguments accepted by the Weaver engine, please reference the +PReS Enhance documentation.

PAGE 892

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 893

Get All Operations Returns a list of all the workflow operations actively running on the Server. Request takes no content, and on success returns a response containing a JSON Operations List of all the actively running operations. Request Method Type: GET URI: /rest/serverengine/workflow/outputcreation/getOperations Content: – Content Type: – Add.

PAGE 894

Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

PAGE 895

Status Code Content ContentType Add. Headers Description authorization token specified in the request headers are invalid.

PAGE 896

Get Progress of Operation Retrieves the progress of a running Output Creation operation of a specific operation ID. Request takes no content, and on success returns a response containing the current value of operation progress (values ranging from 0 – 100, followed by the value of 'done' on completion). Request Method Type: GET URI: /rest/serverengine/workflow/outputcreation/getProgress/{operationId} Content: – Content Type: – Add.

PAGE 897

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Progress value of Output Creation operation text/plain – Progress of operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add.

PAGE 898

Status Code Content ContentType Add. Headers Description the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 899

Get Result of Operation Retrieves the final result of a completed Output Creation operation of a specific operation ID. Request takes no content, and on success returns a response containing either the absolute paths of the final output files produced (multiple spool files) or the content of a final output file (single spool file). Request Method Type: POST URI: /rest/serverengine/workflow/outputcreation/getResult/{operationId} Content: – Content Type: – Add.

PAGE 900

Response Success The following lists status codes indicative of a successful response: Status Code Content Content-Type Add. Headers Description 200 OK Absolute Paths of the Output Files or the Output File itself application/octetstream – Result of completed operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content Content-Type Add.

PAGE 901

Status Code Content Content-Type Add. Headers Description has failed. Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 902

Get Result of Operation (as Text) Retrieves the final result of a completed Output Creation operation of a specific operation ID. Request takes no content, and on success returns a response containing the absolute path or paths of the final output file or files produced (single or multiple spool files respectively). Request Method Type: POST URI: /rest/serverengine/workflow/outputcreation/getResultTxt/{operationId} Content: – Content Type: – Add.

PAGE 903

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 200 OK Absolute Path(s) of the Output File(s) text/plain – Result of completed operation successfully retrieved Error The following lists status codes indicative of a failed or error response: Status Code Content Content-Type Add.

PAGE 904

Status Code Content Content-Type Add. Headers Description Response when the authorization token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 905

Cancel an Operation Requests the cancellation of a running Output Creation operation of a specific operation ID. Request takes no content, and on success returns a response with no content. Request Method Type: POST URI: /rest/serverengine/workflow/outputcreation/cancel/{operationId} Content: – Content Type: – Add.

PAGE 906

Response Success The following lists status codes indicative of a successful response: Status Code Content ContentType Add. Headers Description 204 No Content – – – Operation cancellation requested Error The following lists status codes indicative of a failed or error response: Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required.

PAGE 907

Status Code Content ContentType Add. Headers Description token specified in the request headers has now expired. 403 Forbidden Error message – – Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

PAGE 908

Service Version Returns the version of the Output Creation service. Request Method Type: GET URI: /rest/serverengine/workflow/outputcreation/version Content: – Content Type: – Add.

PAGE 909

Status Code Content ContentType Add. Headers Description 401 Unauthorized – – WWWAuthenticate – BASIC (Basic Authentication credentials are accepted) Server authentication is required. – Server authentication has failed. 401 Unauthorized Error message – Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. Response when the authorization token specified in the request headers has now expired.

PAGE 910

Copyright Information Copyright © 1994–2022 Upland - Objectif Lune All Rights Reserved. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any other language or computer language in whole or in part, in any form or by any means, whether it be electronic, mechanical, magnetic, optical, manual or otherwise, without prior written consent of Upland - Objectif Lune.

PAGE 911

Legal Notices and Acknowledgements PlanetPress Connect REST API, Copyright © 2022, Upland - Objectif Lune All rights reserved. This guide uses the following third party components: l l jQuery Library Copyright © JS Foundation and other contributors. This is distributed under the terms of the Massachusetts Institute of Technology (MIT) license. QUnit Library Copyright © JS/jQuery Foundation and other contributors.

PAGE 912