<
From version < 84.1 >
edited by Thomas Mortagne
on 2021/06/24
To version < 85.1 >
edited by Thomas Mortagne
on 2021/06/24
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -970,12 +970,6 @@
970 970  
971 971  This API is designed to be a REST clone of the JobExecutor Java API (the only real difference right now being way to deal with asynchronous jobs) documented on http://extensions.xwiki.org/xwiki/bin/view/Extension/Job+Module#HUseanexistingjob so the concepts (job type, job request) are the same and the exact information to put in the job request depends on the job you want to run and are usually documented in the extension this job is coming from (extension module, refactoring, etc.). There is JAXB objects provided for the Java side to help generate proper HTTP request but for pure HTTP use case it usually helps to ask for the status of an existing job to have an hint of how the XML/JSON should look like (see [[jobstatus section>>#H2Fjobstatus2F7BjobId7D]]).
972 972  
973 -Since 9.2RC1 jobs started trough the REST API automatically get their runtime context injected with the following REST HTTP request context properties:
974 -
975 -* current wiki
976 -* current user
977 -* request URL and parameters
978 -
979 979  * **HTTP Method:** PUT
980 980  ** **Input:**
981 981  *** Media Types: ##application/xml## or ##application/json##
... ... @@ -989,6 +989,12 @@
989 989  *** 401: If the user is not authorized (i.e. doesn't have Programming Rights)
990 990  *** 500: Failing jobs with ##async=false## return an error 500 (Since 9.7RC1)
991 991  
986 +Jobs started through the REST API automatically get their runtime context injected with the following REST HTTP request context properties:
987 +
988 +* current wiki
989 +* current user
990 +* request URL and parameters
991 +
992 992  == Localization resources ==
993 993  
994 994  For more details see the [[Localization Module documentation>>extensions:Extension.Localization.WebHome]].

Get Connected