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

Class WorkflowController

java.lang.Object

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

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

Constructor Summary

Constructors

Constructor	Description
WorkflowController(WorkflowService workflowService)

Method Summary

Modifier and Type	Method	Description
Result	approve(@Valid ApproveRequestBody approveRequestBody)
PaginatedResultList<SandboxItem>	getItemStates(@NotBlank String siteId, String path, Long states, @javax.validation.constraints.PositiveOrZero int offset, @javax.validation.constraints.PositiveOrZero int limit)
ResultList<SandboxItem>	getWorkflowAffectedPaths(String siteId, String path)
Result	publish(@Valid PublishRequestBody publishRequestBody)
Result	reject(@Valid RejectRequestBody rejectRequestBody)
Result	requestPublish(@Valid RequestPublishRequestBody requestPublishRequestBody)
Result	updateItemStates(@Valid ItemStatesPostRequestBody requestBody)
Result	updateItemStatesByQuery(@Valid UpdateItemStatesByQueryRequestBody requestBody)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowController

@ConstructorProperties("workflowService")
public WorkflowController(WorkflowService workflowService)

Method Detail

getItemStates

@GetMapping(value="/item_states",
            produces="application/json")
public PaginatedResultList<SandboxItem> getItemStates(@NotBlank @RequestParam(name="siteId")
                                                      @NotBlank String siteId,
                                                      @RequestParam(name="path",required=false)
                                                      String path,
                                                      @RequestParam(name="states",required=false)
                                                      Long states,
                                                      @PositiveOrZero @RequestParam(value="offset",required=false,defaultValue="0")
                                                      @javax.validation.constraints.PositiveOrZero int offset,
                                                      @PositiveOrZero @RequestParam(value="limit",required=false,defaultValue="10")
                                                      @javax.validation.constraints.PositiveOrZero int limit)
                                               throws SiteNotFoundException,
                                                      InvalidParametersException

Throws:

SiteNotFoundException

InvalidParametersException

updateItemStates

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

Throws:

SiteNotFoundException

updateItemStatesByQuery

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

Throws:

SiteNotFoundException

getWorkflowAffectedPaths

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

Throws:

ServiceLayerException

UserNotFoundException

requestPublish

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

Throws:

ServiceLayerException

UserNotFoundException

DeploymentException

publish

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

Throws:

UserNotFoundException

ServiceLayerException

DeploymentException

approve

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

Throws:

UserNotFoundException

ServiceLayerException

DeploymentException

reject

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

Throws:

ServiceLayerException

DeploymentException

UserNotFoundException