This functionality is only available for certain module packages.

You are here: Reference > Job definitions > webserviceTrigger

webserviceTrigger

The <webserviceTrigger> tag encloses the definitions for a trigger with which a Job is started via a Webservice interface. This tag has no attribute.

Allowed sub-elements Quantity
outputFolder 1
failedFolder 1

Example call of a Job (without callback)

The Job can be triggered by calling a URL in the browser (HTTP GET) or via an HTTP Webservice call (HTTP POST). Any key-value pairs can be included in sending via the URL parameter (HTTP GET) or in the Request body (HTTP POST). These are accessed in the job definition via trigger.params. The above example shows the access to the complete parameter map and the dedicated value of the key 'mykey', in this case: '1234'.

The progress page for the generated Job is displayed as the response.

Note:

All URL parameters specified are ignored in case of a POST call.

The Job object with status information at the moment of generation is given as the response. Further progress information has to be polled. Alternatively, calling of an external Webservice by the Job Server when the Job has been completed under specification of a callback URL is possible. For more information see the section "Example of Callback call by Job Server".

Example query of the Job status

A Job that has been created but not completed can have the following statuses:

A completed Job can have the following statuses:

Example of Callback call by Job Server

If a Callback URL is specified when creating the Job, the Job Server calls the URL with a POST when the Job has been completed. The response is ignored.

Downloading the generated files

The list of generated files of the Job can be sampled by the downloads link contained in the Job status. The individual file is then downloaded through the included file link. The files have to be made known to the Job Server during the Job execution by means of the MarkFileForDownloadCommand.