com.edorasware.publicapi.rest

Class WorkObjectController

java.lang.Object

com.edorasware.publicapi.rest.WorkObjectController

@ApiController
public class WorkObjectController
extends Object

Provides public REST API for WorkObject manipulation

Method Summary

Modifier and Type	Method and Description
ValueMap	create(String data, String view, List<String> fields)
void	delete(String workObjectId)
QueryResponse	get(String query, Integer start, Integer size, String view, List<String> fields)
ValueMap	getInstance(String ambiguousWorkObjectId, String view, List<String> fields)
Map<String,Object>	getWorkObjectWorkForm(String ambiguousWorkObjectId, Locale locale)
void	options(javax.servlet.http.HttpServletResponse response)
ValueMap	update(String workObjectId, String data, String view, List<String> fields)

Methods inherited from class java.lang.Object

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

Method Detail

get

@RequestMapping(value={"/workobjects","/v1/workobjects"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse get(@RequestParam(required=false)
                                                                                                                                                                           String query,
                                                                                                                                                                           @RequestParam(required=false)
                                                                                                                                                                           Integer start,
                                                                                                                                                                           @RequestParam(required=false,defaultValue="50")
                                                                                                                                                                           Integer size,
                                                                                                                                                                           @RequestParam(required=false)
                                                                                                                                                                           String view,
                                                                                                                                                                           @RequestParam(required=false)
                                                                                                                                                                           List<String> fields)

getInstance

@RequestMapping(value={"/workobjects/{ambiguousWorkObjectId}","/v1/workobjects/{ambiguousWorkObjectId}"},
                method=GET,
                produces="application/json")
 @ResponseBody
public ValueMap getInstance(@PathVariable
                                                                                                                                                                                                                              String ambiguousWorkObjectId,
                                                                                                                                                                                                                              @RequestParam(required=false)
                                                                                                                                                                                                                              String view,
                                                                                                                                                                                                                              @RequestParam(required=false)
                                                                                                                                                                                                                              List<String> fields)

getWorkObjectWorkForm

@RequestMapping(value={"/workobjects/{ambiguousWorkObjectId}/work-form","/v1/workobjects/{ambiguousWorkObjectId}/work-form"},
                method=GET,
                produces="application/json")
 @ResponseBody
public Map<String,Object> getWorkObjectWorkForm(@PathVariable
                                                                                                                                                                                                                                                                      String ambiguousWorkObjectId,
                                                                                                                                                                                                                                                                      Locale locale)

create

@RequestMapping(value={"/workobjects","/v1/workobjects"},
                method=POST,
                produces="application/json",
                consumes="application/json")
 @ResponseBody
public ValueMap create(@RequestBody
                                                                                                                                                                                                                       String data,
                                                                                                                                                                                                                       @RequestParam(required=false)
                                                                                                                                                                                                                       String view,
                                                                                                                                                                                                                       @RequestParam(required=false)
                                                                                                                                                                                                                       List<String> fields)
                                                                                                                                                                                                                throws IOException

Throws:

IOException

update

@RequestMapping(value={"/workobjects/{workObjectId}","/v1/workobjects/{workObjectId}"},
                method=PUT,
                produces="application/json",
                consumes="application/json")
 @ResponseBody
public ValueMap update(@PathVariable
                                                                                                                                                                                                                                                    String workObjectId,
                                                                                                                                                                                                                                                    @RequestBody
                                                                                                                                                                                                                                                    String data,
                                                                                                                                                                                                                                                    @RequestParam(required=false)
                                                                                                                                                                                                                                                    String view,
                                                                                                                                                                                                                                                    @RequestParam(required=false)
                                                                                                                                                                                                                                                    List<String> fields)
                                                                                                                                                                                                                                             throws IOException

Throws:

IOException

delete

@RequestMapping(value={"/workobjects/{workObjectId}","/v1/workobjects/{workObjectId}"},
                method=DELETE)
public void delete(@PathVariable
                                                                                                                                          String workObjectId)
                                                                                                                                   throws IOException

Throws:

IOException

options

@RequestMapping(value={"/workobjects","/v1/workobjects"},
                method=OPTIONS,
                produces="application/json")
public void options(javax.servlet.http.HttpServletResponse response)
                                                                                                                                                    throws IOException

Throws:

IOException