Component | Category | Description |
---|---|---|
Excel Import Plugin 5.0.0-SNAPSHOT | Dependency | PUZZLE core version 50.0.0-SNAPSHOT. |
Improvement | Possible Breaking Change: The endpoint POST /import/excel now returns an explicit error message if it can parse the body, but cannot parse job(s) from the Excel file provided in the attribute data . |
|
Excel Import Plugin 4.2.1 | Dependency | PUZZLE core version 49.2.0. |
Excel Import Plugin 4.1.0 | Dependency | PUZZLE core version 48.0.0. |
Excel Import Plugin 4.0.0 | Bug | Client must always sent attribute parameter in the request body of POST /import/excel. If the client does not want to set a parameter, it has to set parameter to an empty array. |
Documentation | Keys and values of parameters must always be strings. This concerns the endpoint POST /import/excel |
Plugin for PUZZLE, which allows a client to import multiple jobs from a Microsoft Excel file.
Precondition: None.
PUZZLE imports all jobs defined in the excel file.
A client must send a request body that contains a JSON object with two attributes: The attribute data
contains the base64-coded Excel file, with the structure described here and the parameters
attribute contains the parameters PUZZLE uses every job it can extract from the Excel file.
Every extracted job has the same conditions as if it were created from the JSON representation.
PUZZLE responds with an array of all jobId
s it extracted from the Excel file.
If PUZZLE cannot parse a JSON representation, it returns with HTTP status code 400 and a JSON object as response body that encodes a parsing error (see Section error and response samples with HTTP status code 400). In this case, PUZZLE creates neither a job nor a jobId
.
data required | string <byte> Base64 encoded excel file. |
parameters required | object Hash map of the parameters used by PUZZLE. PUZZLE uses default values for each parameter. A client can override any default value by explicitly setting a parameter value. Setting undocumented parameters may result in undefined behavior. See the main documentation for a detailed description of the parameters. |
Import was successful
sheet required | string Name of the worksheet from which PUZZLE parsed the job. |
ordernumber required | string Number of the order of the parsed job |
jobId | integer <int64> >= 1 unique ID for the newly created job |
PUZZLE cannot parse the JSON in the request body.
An error occurred.