Search: concept

REST API

Rendered document content

Understanding resources and representations "An important concept in REST is the existence of resources (sources of specific information), each of which is referenced with a global identifier (e.g., an URI in HTTP).

…

/jobstatus/{jobId} Request parameters: Name Required Values Default Description Version request no true|false false Return also the job request 9.1RC1 progress no true|false true Return also the job progress 9.1RC1 log no true|false false Return also the job log 9.1RC1 log_fromLevel no error|warn|info|debug|trace Indicate the level from which to return logs 9.1RC1 HTTP Method: GET Media types: application/xml (JobStatus element) Description: status of a job Status codes: 200: If the request was successful. 404: If the job status has not been found /joblog/{jobId} Request parameters: Name Required Values Default Description Version level no error|warn|info|debug|trace Indicate the exact level for which to return logs 7.2M3 fromLevel no error|warn|info|debug|trace Indicate the level from which to return logs 7.2M3 HTTP Method: GET Media types: application/xml (JobLog element) Description: log of a job Status codes: 200: If the request was successful. 404: If the job status has not been found /jobs Request parameters: Name Required Values Default Description Version jobType yes The type of the job to pass to the Job Executor 9.1RC1 async no true|false true If false, return the response only when the job is done 9.1RC1 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.).

Raw document content

= Understanding resources and representations = "An important concept in REST is the existence of resources (sources of specific information), each of which is referenced with a global identifier (e.g., an URI in HTTP).

…

(eg: ##refactoring/delete/11451##). === /jobstatus/{jobId} {{info}}Since 7.2M3{{/info}} === Request parameters: |=Name|=Required|=Values|=Default|=Description|=Version |##request##|no|##true~|false##|##false##|Return also the job request|9.1RC1 |##progress##|no|##true~|false##|##true##|Return also the job progress|9.1RC1 |##log##|no|##true~|false##|##false##|Return also the job log|9.1RC1 |##log_fromLevel##|no|##error~|warn~|info~|debug~|trace##| |Indicate the level from which to return logs|9.1RC1 * **HTTP Method:** GET ** **Media types:** *** application/xml (JobStatus element) ** **Description:** status of a job ** **Status codes:** *** 200: If the request was successful. *** 404: If the job status has not been found === /joblog/{jobId} {{info}}Since 7.2M3{{/info}} === Request parameters: |=Name|=Required|=Values|=Default|=Description|=Version |##level##|no|##error~|warn~|info~|debug~|trace##| |Indicate the exact level for which to return logs|7.2M3 |##fromLevel##|no|##error~|warn~|info~|debug~|trace##| |Indicate the level from which to return logs|7.2M3 * **HTTP Method:** GET ** **Media types:** *** application/xml (JobLog element) ** **Description:** log of a job ** **Status codes:** *** 200: If the request was successful. *** 404: If the job status has not been found === /jobs {{info}}Since 9.1RC1{{/info}} === Request parameters: |=Name|=Required|=Values|=Default|=Description|=Version |##jobType##|yes| | |The type of the job to pass to the Job Executor|9.1RC1 |##async##|no|##true~|false##|##true##|If false, return the response only when the job is done|9.1RC1 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