Package org.craftercms.studio.controller.rest.v2

Class WorkflowController

java.lang.Object

org.craftercms.studio.controller.rest.v2.WorkflowController

@RestController
@RequestMapping("/api/2/workflow")
public class WorkflowController
extends Object

Constructor Summary

Constructors

Constructor	Description
WorkflowController()

Method Summary

Modifier and Type	Method	Description
ResponseBody	approve(ApproveRequestBody approveRequestBody)
ResponseBody	getItemStates(String siteId, Optional<String> rpPath, Optional<Long> rpStates, int offset, int limit)
SiteService	getSiteService()
ResponseBody	getWorkflowAffectedPaths(String siteId, String path)
WorkflowService	getWorkflowService()
ResponseBody	publish(PublishRequestBody publishRequestBody)
ResponseBody	reject(RejectRequestBody rejectRequestBody)
ResponseBody	requestPublish(@Valid RequestPublishRequestBody requestPublishRequestBody)
void	setSiteService(SiteService siteService)
void	setWorkflowService(WorkflowService workflowService)
ResponseBody	updateItemStates(ItemStatesPostRequestBody requestBody)
ResponseBody	updateItemStatesByQuery(UpdateItemStatesByQueryRequestBody requestBody)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowController

public WorkflowController()

Method Detail

getItemStates

@GetMapping(value="/item_states",
            produces="application/json")
public ResponseBody getItemStates(@RequestParam(name="siteId")
                                  String siteId,
                                  @RequestParam(name="path",required=false)
                                  Optional<String> rpPath,
                                  @RequestParam(name="states",required=false)
                                  Optional<Long> rpStates,
                                  @RequestParam(value="offset",required=false,defaultValue="0")
                                  int offset,
                                  @RequestParam(value="limit",required=false,defaultValue="10")
                                  int limit)
                           throws SiteNotFoundException

Throws:

SiteNotFoundException

updateItemStates

@PostMapping(value="/item_states",
             produces="application/json")
public ResponseBody updateItemStates(@RequestBody
                                     ItemStatesPostRequestBody requestBody)
                              throws SiteNotFoundException

Throws:

SiteNotFoundException

updateItemStatesByQuery

@PostMapping(value="/update_item_states_by_query",
             produces="application/json")
public ResponseBody updateItemStatesByQuery(@RequestBody
                                            UpdateItemStatesByQueryRequestBody requestBody)
                                     throws SiteNotFoundException

Throws:

SiteNotFoundException

getWorkflowAffectedPaths

@GetMapping(value="/affected_paths",
            produces="application/json")
public ResponseBody getWorkflowAffectedPaths(@RequestParam("siteId")
                                             String siteId,
                                             @RequestParam("path")
                                             String path)
                                      throws ServiceLayerException,
                                             UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

requestPublish

@PostMapping(value="/request_publish",
             consumes="application/json")
public ResponseBody requestPublish(@RequestBody @Valid
                                   @Valid RequestPublishRequestBody requestPublishRequestBody)
                            throws ServiceLayerException,
                                   UserNotFoundException,
                                   DeploymentException

Throws:

ServiceLayerException

UserNotFoundException

DeploymentException

publish

@PostMapping(value="/publish",
             consumes="application/json")
public ResponseBody publish(@RequestBody
                            PublishRequestBody publishRequestBody)
                     throws UserNotFoundException,
                            ServiceLayerException,
                            DeploymentException

Throws:

UserNotFoundException

ServiceLayerException

DeploymentException

approve

@PostMapping(value="/approve",
             consumes="application/json")
public ResponseBody approve(@RequestBody
                            ApproveRequestBody approveRequestBody)
                     throws UserNotFoundException,
                            ServiceLayerException,
                            DeploymentException

Throws:

UserNotFoundException

ServiceLayerException

DeploymentException

reject

@PostMapping(value="/reject",
             consumes="application/json")
public ResponseBody reject(@RequestBody
                           RejectRequestBody rejectRequestBody)
                    throws ServiceLayerException,
                           DeploymentException

Throws:

ServiceLayerException

DeploymentException

getWorkflowService

public WorkflowService getWorkflowService()

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

getSiteService

public SiteService getSiteService()

setSiteService

public void setSiteService(SiteService siteService)