Specifications of web service requests
Starting a job – XML file upload
Method: |
Multipart/form-data post |
Endpoint: |
/processXML |
Parameters:
Name |
Type |
Description |
|---|---|---|
file |
HTML file |
Binary content as a html file |
returnType |
String |
returnType=report Returns the job log of the job returnType=pdf Returns the output PDF (Require mediaType=’archive’). |
detailed |
Boolean |
detailed=true: Returns extended job log with all subjobs detailed=false: Returns only top job |
locale (*) |
String |
Translates the text descriptions to the specified locale, e.g.: locale=en_GB: Returns english translation locale=de_DE: Returns german translation |
Optional meta data keys |
String |
Additional parameters are treated as metadata e.g.: interform.log.info=hello_world sets the interform.log.info key/value to ”hello_world” |
(*) Not all locales have been implemented.
Starting a job – XML parameter
Alternative normal post method to uploading XML as a file, the parameter file is a string containing the XML content.
Get job status
Endpoint: /getJobReport
Method: Get or post
Parameters
(A request must have either id or info, but not both)
Name |
Type |
Description |
|---|---|---|
id |
Integer |
The id of the job |
info |
String |
The interform.log.info meta data key for the job |
detailed |
Boolean |
detailed=true: Returns extended job log with all subjobs detailed=false: Returns only top job |
locale (*) |
String |
Translates the text descriptions to the specified locale, e.g.: locale=en_GB: Returns english translation locale=de_DE: Returns german translation |
(*) Not all locales are implemented.
XML return format
Name |
Type |
Description |
|---|---|---|
report |
Root element |
Contains: status (1), jobLogId (1) and job (0..*). |
jobLogId |
ID |
Id of the starting log job in a report. |
status |
Status of the job |
OK= Everything went ok. WARNING = Success, but with a warning. ERROR = Error during processing. |
job |
Element |
Contains: id (1) – The id of the sub job status (1) – The status of the sub job type (1) – The type of the sub job message (0..*) - Messages for sub job job (0..*) - Sub jobs |
id |
ID |
Id of a job |
type |
String |
Type of the job, e.g. FILESYSTEM, DATABASE, PDF or FTP. |
message |
Element |
Contains: text, parameters, message_code. |
parameters |
String |
Parameters as a json array as string. |
text |
String |
The translated text (or just english). |
Input example:
Output example:
