Changes for page REST API

Last modified by Thomas Mortagne on 2024/03/12

<
From version < 62.1 >
edited by Thomas Mortagne
on 2017/02/20
To version < 66.1 >
edited by Thomas Mortagne
on 2017/03/28
>
Change comment: Fix jira URLs

Summary

Details

Page properties
Content
... ... @@ -903,10 +903,10 @@
903 903  Request parameters:
904 904  
905 905  |=Name|=Required|=Values|=Default|=Description|=Version
906 -|##request##|no|true~|false|false|Return also the job request|9.1RC1
907 -|##progress##|no|true~|false|true|Return also the job progress|9.1RC1
908 -|##log##|true~|no|false|false|Return also the job log|9.1RC1
909 -|##log_fromLevel##|no|error~|warn~|info~|debug~|trace||Indicate the level from which to return logs|9.1RC1
906 +|##request##|no|##true~|false##|##false##|Return also the job request|9.1RC1
907 +|##progress##|no|##true~|false##|##true##|Return also the job progress|9.1RC1
908 +|##log##|no|##true~|false##|##false##|Return also the job log|9.1RC1
909 +|##log_fromLevel##|no|##error~|warn~|info~|debug~|trace##||Indicate the level from which to return logs|9.1RC1
910 910  
911 911  * **HTTP Method:** GET
912 912  ** **Media types:**
... ... @@ -916,10 +916,14 @@
916 916  *** 200: If the request was successful.
917 917  *** 404: If the job status has not been found
918 918  
919 -=== /joblog/{jobId}[&level ===
919 +=== /joblog/{jobId} {{info}}Since 7.2M3{{/info}} ===
920 920  
921 -{error,warn,info,debug,trace}][&fromLevel={error,warn,info,debug,trace}] {{info}}Since 7.2M3{{/info}} ===
921 +Request parameters:
922 922  
923 +|=Name|=Required|=Values|=Default|=Description|=Version
924 +|##level##|no|##error~|warn~|info~|debug~|trace##||Indicate the exact level for which to return logs|7.2M3
925 +|##fromLevel##|no|##error~|warn~|info~|debug~|trace##||Indicate the level from which to return logs|7.2M3
926 +
923 923  * **HTTP Method:** GET
924 924  ** **Media types:**
925 925  *** application/xml (JobLog element)
... ... @@ -933,8 +933,16 @@
933 933  Request parameters:
934 934  
935 935  |=Name|=Required|=Values|=Default|=Description|=Version
936 -|##async##|no|true~|false|true|If false, return the response only when the job is done|9.1RC1
940 +|##async##|no|##true~|false##|##true##|If false, return the response only when the job is done|9.1RC1
937 937  
942 +Since 9.2RC1 jobs started trough the REST API automatically get their runtime context injected with the following REST HTTP request context properties:
943 +
944 +* current wiki
945 +* current user
946 +* current document
947 +* current secure document
948 +* request URL and parameters
949 +
938 938  * **HTTP Method:** PUT
939 939  ** **Accepted Media types:**
940 940  *** application/xml (JobRequest element)
XWiki.XWikiComments[6]
Comment
... ... @@ -1,4 +1,4 @@
1 -Based on the feature request at http://jira.xwiki.org/browse/XWIKI-9123#comment-74977 It is possible to fetch the XHTML content from URL such as
1 +Based on the feature request at https://jira.xwiki.org/browse/XWIKI-9123#comment-74977 It is possible to fetch the XHTML content from URL such as
2 2  http://platform.xwiki.org/xwiki/bin/get/Features/XWikiRESTfulAPI
3 3  or via
4 4  http://platform.xwiki.org/xwiki/bin/view/Features/XWikiRESTfulAPI?xpage=plain&outputSyntax=xhtml

Get Connected