org.flowable.ui.admin.rest.client

Class BatchClientResource

java.lang.Object

org.flowable.ui.admin.rest.client.AbstractClientResource

org.flowable.ui.admin.rest.client.BatchClientResource

@RestController
public class BatchClientResource
extends AbstractClientResource

REST controller for managing the batch.

Field Summary

Fields

Modifier and Type	Field and Description
protected BatchService	clientService

Fields inherited from class org.flowable.ui.admin.rest.client.AbstractClientResource

configRepository

Constructor Summary

Constructors

Constructor and Description
BatchClientResource()

Method Summary

Modifier and Type	Method and Description
void	deleteJob(String batchId, javax.servlet.http.HttpServletRequest request) DELETE /rest/admin/batches/{batchId} -> delete batch
com.fasterxml.jackson.databind.JsonNode	getBatch(String batchId, javax.servlet.http.HttpServletRequest request) GET /rest/admin/batches/{batchId} -> return batch data
String	getBatchDocument(String batchId, javax.servlet.http.HttpServletRequest request) GET /rest/admin/batches/{batchId}/batch-document
com.fasterxml.jackson.databind.JsonNode	getBatchParts(String batchId, javax.servlet.http.HttpServletRequest request) GET /rest/admin/batches/{batchId}/batch-parts

Methods inherited from class org.flowable.ui.admin.rest.client.AbstractClientResource

getRequestParametersWithoutServerId, retrieveServerConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientService

@Autowired
protected BatchService clientService

Constructor Detail

BatchClientResource

public BatchClientResource()

Method Detail

getBatch

@GetMapping(value="/rest/admin/batches/{batchId}",
            produces="application/json")
public com.fasterxml.jackson.databind.JsonNode getBatch(@PathVariable
                                                                                                                                                    String batchId,
                                                                                                                                                    javax.servlet.http.HttpServletRequest request)
                                                                                                                                             throws org.flowable.ui.common.service.exception.BadRequestException

GET /rest/admin/batches/{batchId} -> return batch data

Throws:

org.flowable.ui.common.service.exception.BadRequestException

getBatchParts

@GetMapping(value="/rest/admin/batches/{batchId}/batch-parts",
            produces="application/json")
public com.fasterxml.jackson.databind.JsonNode getBatchParts(@PathVariable
                                                                                                                                                                     String batchId,
                                                                                                                                                                     javax.servlet.http.HttpServletRequest request)
                                                                                                                                                              throws org.flowable.ui.common.service.exception.BadRequestException

GET /rest/admin/batches/{batchId}/batch-parts

Throws:

org.flowable.ui.common.service.exception.BadRequestException

deleteJob

@DeleteMapping(value="/rest/admin/batches/{batchId}",
               produces="application/json")
 @ResponseStatus(value=OK)
public void deleteJob(@PathVariable
                                                                                                                                                   String batchId,
                                                                                                                                                   javax.servlet.http.HttpServletRequest request)
                                                                                                                                            throws org.flowable.ui.common.service.exception.BadRequestException

DELETE /rest/admin/batches/{batchId} -> delete batch

Throws:

org.flowable.ui.common.service.exception.BadRequestException

getBatchDocument

@GetMapping(value="/rest/admin/batches/{batchId}/batch-document",
            produces="text/plain")
public String getBatchDocument(@PathVariable
                                                                                                                                    String batchId,
                                                                                                                                    javax.servlet.http.HttpServletRequest request)
                                                                                                                             throws org.flowable.ui.common.service.exception.BadRequestException

GET /rest/admin/batches/{batchId}/batch-document

Throws:

org.flowable.ui.common.service.exception.BadRequestException