@ApiController public class FormDefinitionController extends Object
This class implements Form definition specific public API methods
| Constructor and Description | 
|---|
FormDefinitionController(WorkObjectDefinitionManager workObjectDefinitionManager,
                        FormDefinitionManager formDefinitionManager)  | 
| Modifier and Type | Method and Description | 
|---|---|
QueryResponse | 
getEntityTemplatesByType(String nameFilter,
                        String modelId,
                        String caseId,
                        Integer start,
                        Integer size,
                        Locale locale)
Returns all the form definitions matching the provided name filter or model global id. 
 | 
Map<String,Object> | 
getFormDefinitionByKey(String formKey,
                      Locale locale)  | 
ValueMap | 
getInstance(String ambiguousWorkObjectDefinitionId,
           String view,
           List<String> fields,
           Locale locale)
Returns the form definition matching the id. 
 | 
@Autowired public FormDefinitionController(WorkObjectDefinitionManager workObjectDefinitionManager, FormDefinitionManager formDefinitionManager)
@RequestMapping(value={"/form-definitions","/v1/form-definitions"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse getEntityTemplatesByType(@RequestParam(required=false,defaultValue="")
                                                                                                                                                                                                          String nameFilter,
                                                                                                                                                                                                          @RequestParam(required=false)
                                                                                                                                                                                                          String modelId,
                                                                                                                                                                                                          @RequestParam(required=false)
                                                                                                                                                                                                          String caseId,
                                                                                                                                                                                                          @RequestParam(required=false)
                                                                                                                                                                                                          Integer start,
                                                                                                                                                                                                          @RequestParam(required=false,defaultValue="50")
                                                                                                                                                                                                          Integer size,
                                                                                                                                                                                                          Locale locale)
Returns all the form definitions matching the provided name filter or model global id.
nameFilter - query to search for the typed textmodelId - query definitions based on a global model idcaseId - query definitions based on the restrictions of a case id or case global id@ResponseBody
 @RequestMapping(value={"/form-definitions/single/{formKey}","/v1/form-definitions/single/{formKey}"},
                method=GET,
                produces="application/json")
public Map<String,Object> getFormDefinitionByKey(@PathVariable
                                                                                                                                                                                                                                               String formKey,
                                                                                                                                                                                                                                               Locale locale)
                                                                                                                                                                                                                                        throws Exception
Exception@RequestMapping(value={"/form-definitions/{ambiguousWorkObjectDefinitionId}","/v1/form-definitions/{ambiguousWorkObjectDefinitionId}"},
                method=GET,
                produces="application/json")
 @ResponseBody
public ValueMap getInstance(@PathVariable
                                                                                                                                                                                                                                                            String ambiguousWorkObjectDefinitionId,
                                                                                                                                                                                                                                                            @RequestParam(required=false)
                                                                                                                                                                                                                                                            String view,
                                                                                                                                                                                                                                                            @RequestParam(required=false)
                                                                                                                                                                                                                                                            List<String> fields,
                                                                                                                                                                                                                                                            Locale locale)
Returns the form definition matching the id.
ambiguousWorkObjectDefinitionId - query definitions based on a work object definition id or global model idCopyright © 2010 - 2019 edorasware ag. All Rights Reserved.