PUZZLE HTML Report Plugin (13.4.0)

Changelog

Component	Category	Description
HTML Report Plugin 13.4.0	Dependency	PUZZLE core version 49.2.0.
HTML Report Plugin 13.2.0	Dependency	PUZZLE core version 48.0.0.
HTML Report Plugin 13.0.1	Dependency	PUZZLE core version 47.0.0.

Description

Plugin for PUZZLE, that allows a client to create an interactive html report for the solutions of a job. The report contains a step-by-step simulation of the load of the loading devices.

A client can define the color of the loading device and the colors of the sides of the items. Please see the PUZZLE REST API Documentation for details.

/export/{jobId}.html

Precondition: the state of the job is DONE.

Returns the interactive html report for the job with HTTP status code 200.

If you specify an unknown jobId, PUZZLE returns an error with HTTP status code 404 (see response samples for 404).

If the job does not have the state expected in the precondition, PUZZLE returns an error with HTTP status code 500 (see response samples for 500).

path Parameters

jobId

required

integer <int64> >= 1

The Id of the job.

Responses

200

The interactive html report.

Pallet example Carton example Best-fit example

Response Schema: text/html

string

404

There does not exist a job with the given jobId.

500

An error occurred.

get /export/{jobId}.html

PUZZLE instance at host hostname port 8888

http://hostname:8888/puzzle/api/v1/export/{jobId}.html

PUZZLE instance at localhost port 8888

http://localhost:8888/puzzle/api/v1/export/{jobId}.html

Response samples

application/json

Copy

Expand all Collapse all

{

"errorMessage": "PUZZLE cannot find job with id 123",
"additionalInformation": "",
"errorClass": "de.fraunhofer.iml.puzzle.adapter.execution.Exceptions.Rest.PuzzleJobNotFoundException"

}