Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public class AppDefinitionCollectionResource {
@Autowired(required=false)
protected AppRestApiInterceptor restApiInterceptor;

@ApiOperation(value = "List of app definitions", nickname = "listAppDefinitions", tags = { "App Definitions" })
@ApiOperation(value = "List of app definitions", nickname = "listAppDefinitions", tags = { "App Definitions" }, notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "category", dataType = "string", value = "Only return app definitions with the given category.", paramType = "query"),
@ApiImplicitParam(name = "categoryLike", dataType = "string", value = "Only return app definitions with a category like the given value.", paramType = "query"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public class AppDeploymentCollectionResource {
@Autowired(required=false)
protected AppRestApiInterceptor restApiInterceptor;

@ApiOperation(value = "List of App Deployments", nickname = "listAppDeployments", tags = { "App Deployments" })
@ApiOperation(value = "List of App Deployments", nickname = "listAppDeployments", tags = { "App Deployments" }, notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "name", dataType = "string", value = "Only return app deployments with the given name.", paramType = "query"),
@ApiImplicitParam(name = "nameLike", dataType = "string", value = "Only return app deployments with a name like the given name.", paramType = "query"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
@Api(tags = { "History Case" }, authorizations = { @Authorization(value = "basicAuth") })
public class HistoricCaseInstanceCollectionResource extends HistoricCaseInstanceBaseResource {

@ApiOperation(value = "List of historic case instances", tags = { "History Case" }, nickname = "listHistoricCaseInstances")
@ApiOperation(value = "List of historic case instances", tags = { "History Case" }, nickname = "listHistoricCaseInstances", notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "caseInstanceId", dataType = "string", value = "An id of the historic case instance.", paramType = "query"),
@ApiImplicitParam(name = "caseInstanceIds", dataType = "string", value = "Only return historic case instances with the given comma-separated ids.", paramType = "query"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
@Api(tags = { "History Task" }, authorizations = { @Authorization(value = "basicAuth") })
public class HistoricTaskInstanceCollectionResource extends HistoricTaskInstanceBaseResource {

@ApiOperation(value = "List historic task instances", tags = { "History Task" }, nickname = "listHistoricTaskInstances")
@ApiOperation(value = "List historic task instances", tags = { "History Task" }, nickname = "listHistoricTaskInstances", notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "taskId", dataType = "string", value = "An id of the historic task instance.", paramType = "query"),
@ApiImplicitParam(name = "caseInstanceId", dataType = "string", value = "The case instance id of the historic task instance.", paramType = "query"),
Expand Down Expand Up @@ -226,6 +226,10 @@ public DataResponse<HistoricTaskInstanceResponse> getHistoricProcessInstances(@A
queryRequest.setDueDateBefore(RequestUtil.getDate(allRequestParams, "dueDateBefore"));
}

if (allRequestParams.containsKey("withoutDueDate") && Boolean.parseBoolean(allRequestParams.get("withoutDueDate"))) {
queryRequest.setWithoutDueDate(Boolean.TRUE);
}

if (allRequestParams.get("taskCreatedOn") != null) {
queryRequest.setTaskCreatedOn(RequestUtil.getDate(allRequestParams, "taskCreatedOn"));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
@Api(tags = { "History" }, authorizations = { @Authorization(value = "basicAuth") })
public class HistoricVariableInstanceCollectionResource extends HistoricVariableInstanceBaseResource {

@ApiOperation(value = "List of historic variable instances", tags = { "History" }, nickname = "listHistoricVariableInstances")
@ApiOperation(value = "List of historic variable instances", tags = { "History" }, nickname = "listHistoricVariableInstances", notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "caseInstanceId", dataType = "string", value = "The case instance id of the historic variable instance.", paramType = "query"),
@ApiImplicitParam(name = "taskId", dataType = "string", value = "The task id of the historic variable instance.", paramType = "query"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public class DeadLetterJobCollectionResource {
@Autowired(required=false)
protected CmmnRestApiInterceptor restApiInterceptor;

@ApiOperation(value = "List deadletter jobs", tags = { "Jobs" }, nickname = "listDeadLetterJobs")
@ApiOperation(value = "List deadletter jobs", tags = { "Jobs" }, nickname = "listDeadLetterJobs", notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", dataType = "string", value = "Only return job with the given id", paramType = "query"),
@ApiImplicitParam(name = "caseInstanceId", dataType = "string", value = "Only return jobs part of a case with the given id", paramType = "query"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public class HistoryJobCollectionResource {
@Autowired(required=false)
protected CmmnRestApiInterceptor restApiInterceptor;

@ApiOperation(value = "List history jobs", tags = { "Jobs" }, nickname = "listDeadLetterJobs")
@ApiOperation(value = "List history jobs", tags = { "Jobs" }, nickname = "listDeadLetterJobs", notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", dataType = "string", value = "Only return the job with the given id", paramType = "query"),
@ApiImplicitParam(name = "withException", dataType = "boolean", value = "If true, only return jobs for which an exception occurred while executing it. If false, this parameter is ignored.", paramType = "query"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public class JobCollectionResource {
protected CmmnEngineConfiguration cmmnEngineConfiguration;

// Fixme documentation & real parameters
@ApiOperation(value = "List jobs", tags = { "Jobs" }, nickname = "listJobs")
@ApiOperation(value = "List jobs", tags = { "Jobs" }, nickname = "listJobs", notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", dataType = "string", value = "Only return job with the given id", paramType = "query"),
@ApiImplicitParam(name = "caseInstanceId", dataType = "string", value = "Only return jobs part of a case with the given id", paramType = "query"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public class SuspendedJobCollectionResource {
protected CmmnRestApiInterceptor restApiInterceptor;

// Fixme documentation & real parameters
@ApiOperation(value = "List suspended jobs", tags = { "Jobs" }, nickname = "listSuspendedJobs")
@ApiOperation(value = "List suspended jobs", tags = { "Jobs" }, nickname = "listSuspendedJobs", notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", dataType = "string", value = "Only return job with the given id", paramType = "query"),
@ApiImplicitParam(name = "caseInstanceId", dataType = "string", value = "Only return jobs part of a case with the given id", paramType = "query"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public class TimerJobCollectionResource {
protected CmmnRestApiInterceptor restApiInterceptor;

// Fixme documentation & real parameters
@ApiOperation(value = "List timer jobs", tags = { "Jobs" }, nickname = "listTimerJobs")
@ApiOperation(value = "List timer jobs", tags = { "Jobs" }, nickname = "listTimerJobs", notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", dataType = "string", value = "Only return job with the given id", paramType = "query"),
@ApiImplicitParam(name = "caseInstanceId", dataType = "string", value = "Only return jobs part of a case with the given id", paramType = "query"),
Expand Down
Comment thread
filiphr marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -67,24 +67,26 @@ public class CaseDefinitionCollectionResource {
@Autowired(required=false)
protected CmmnRestApiInterceptor restApiInterceptor;

@ApiOperation(value = "List of case definitions", tags = { "Case Definitions" }, nickname = "listCaseDefinitions")
@ApiOperation(value = "List of case definitions", tags = { "Case Definitions" }, nickname = "listCaseDefinitions",
notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?categoryLike=acme%25' to match categories starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "version", dataType = "integer", value = "Only return case definitions with the given version.", paramType = "query"),
@ApiImplicitParam(name = "name", dataType = "string", value = "Only return case definitions with the given name.", paramType = "query"),
@ApiImplicitParam(name = "nameLike", dataType = "string", value = "Only return case definitions with a name like the given name.", paramType = "query"),
@ApiImplicitParam(name = "nameLikeIgnoreCase", dataType = "string", value = "Only return case definitions with a name like the given name ignoring case.", paramType = "query"),
@ApiImplicitParam(name = "nameLikeIgnoreCase", dataType = "string", value = "Only return case definitions with a name like the given name, ignoring case.", paramType = "query"),
@ApiImplicitParam(name = "key", dataType = "string", value = "Only return case definitions with the given key.", paramType = "query"),
@ApiImplicitParam(name = "keyLike", dataType = "string", value = "Only return case definitions with a name like the given key.", paramType = "query"),
@ApiImplicitParam(name = "keyLike", dataType = "string", value = "Only return case definitions with a key like the given key.", paramType = "query"),
@ApiImplicitParam(name = "resourceName", dataType = "string", value = "Only return case definitions with the given resource name.", paramType = "query"),
@ApiImplicitParam(name = "resourceNameLike", dataType = "string", value = "Only return case definitions with a name like the given resource name.", paramType = "query"),
@ApiImplicitParam(name = "resourceNameLike", dataType = "string", value = "Only return case definitions with a resource name like the given resource name.", paramType = "query"),
@ApiImplicitParam(name = "category", dataType = "string", value = "Only return case definitions with the given category.", paramType = "query"),
@ApiImplicitParam(name = "categoryLike", dataType = "string", value = "Only return case definitions with a category like the given name.", paramType = "query"),
@ApiImplicitParam(name = "categoryLike", dataType = "string", value = "Only return case definitions with a category like the given category.", paramType = "query"),
@ApiImplicitParam(name = "categoryNotEquals", dataType = "string", value = "Only return case definitions which do not have the given category.", paramType = "query"),
@ApiImplicitParam(name = "deploymentId", dataType = "string", value = "Only return case definitions which are part of a deployment with the given deployment id.", paramType = "query"),
@ApiImplicitParam(name = "parentDeploymentId", dataType = "string", value = "Only return case definitions which are part of a deployment with the given parent deployment id.", paramType = "query"),
@ApiImplicitParam(name = "startableByUser", dataType = "string", value = "Only return case definitions which are part of a deployment with the given id.", paramType = "query"),
@ApiImplicitParam(name = "startableByUser", dataType = "string", value = "Only return case definitions which can be started by the user with the given id.", paramType = "query"),
@ApiImplicitParam(name = "tenantId", dataType = "string", value = "Only return case definitions with the given tenant id.", paramType = "query"),
@ApiImplicitParam(name = "tenantIdLike", dataType = "string", value = "Only return case definitions with a tenant id like the given tenant id.", paramType = "query"),
@ApiImplicitParam(name = "latest", dataType = "boolean", value = "Only return the latest case definition versions. Can only be used together with key and keyLike parameters, using any other parameter will result in a 400-response.", paramType = "query"),
@ApiImplicitParam(name = "suspended", dataType = "boolean", value = "If true, only returns case definitions which are suspended. If false, only active process definitions (which are not suspended) are returned.", paramType = "query"),
@ApiImplicitParam(name = "sort", dataType = "string", value = "Property to sort on, to be used together with the order.", allowableValues = "name,id,key,category,deploymentId,version", paramType = "query"),
@ApiImplicitParam(name = "order", dataType = "string", value = "The sort order, either 'asc' or 'desc'. Defaults to 'asc'.", paramType = "query"),
@ApiImplicitParam(name = "start", dataType = "integer", value = "Index of the first row to fetch. Defaults to 0.", paramType = "query"),
Expand All @@ -95,7 +97,7 @@ public class CaseDefinitionCollectionResource {
@ApiResponse(code = 400, message = "Indicates a parameter was passed in the wrong format or that latest is used with other parameters other than key and keyLike. The status-message contains additional information.")
})
@GetMapping(value = "/cmmn-repository/case-definitions", produces = "application/json")
public DataResponse<CaseDefinitionResponse> getProcessDefinitions(@ApiParam(hidden = true) @RequestParam Map<String, String> allRequestParams) {
public DataResponse<CaseDefinitionResponse> getCaseDefinitions(@ApiParam(hidden = true) @RequestParam Map<String, String> allRequestParams) {
CaseDefinitionQuery caseDefinitionQuery = repositoryService.createCaseDefinitionQuery();

// Populate filter-parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public class DeploymentCollectionResource {
@Autowired(required=false)
protected CmmnRestApiInterceptor restApiInterceptor;

@ApiOperation(value = "List Deployments", tags = { "Deployment" }, nickname="listDeployments")
@ApiOperation(value = "List Deployments", tags = { "Deployment" }, nickname="listDeployments", notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "name", dataType = "string", value = "Only return deployments with the given name.", paramType = "query"),
@ApiImplicitParam(name = "nameLike", dataType = "string", value = "Only return deployments with a name like the given name.", paramType = "query"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public class CaseInstanceCollectionResource extends BaseCaseInstanceResource {
@Autowired
protected CmmnHistoryService historyService;

@ApiOperation(value = "List case instances", nickname ="listCaseInstances", tags = { "Case Instances" })
@ApiOperation(value = "List case instances", nickname ="listCaseInstances", tags = { "Case Instances" }, notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", dataType = "string", value = "Only return case instances with the given id.", paramType = "query"),
@ApiImplicitParam(name = "ids", dataType = "string", value = "Only return case instances with the given comma-separated ids.", paramType = "query"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@
@Api(tags = { "Tasks" }, authorizations = { @Authorization(value = "basicAuth") })
public class TaskCollectionResource extends TaskBaseResource {

@ApiOperation(value = "List of tasks", nickname="listTasks", tags = { "Tasks" })
@ApiOperation(value = "List of tasks", nickname="listTasks", tags = { "Tasks" }, notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "taskId", dataType = "string", value = "Only return tasks with the given id.", paramType = "query"),
@ApiImplicitParam(name = "name", dataType = "string", value = "Only return tasks with the given version.", paramType = "query"),
@ApiImplicitParam(name = "name", dataType = "string", value = "Only return tasks with the given name.", paramType = "query"),
@ApiImplicitParam(name = "nameLike", dataType = "string", value = "Only return tasks with a name like the given name.", paramType = "query"),
@ApiImplicitParam(name = "nameLikeIgnoreCase", dataType = "string", value = "Only return tasks with a name like the given name ignoring case.", paramType = "query"),
@ApiImplicitParam(name = "description", dataType = "string", value = "Only return tasks with the given description.", paramType = "query"),
Expand Down Expand Up @@ -290,6 +290,10 @@ public DataResponse<TaskResponse> getTasks(@ApiParam(hidden = true) @RequestPara
request.setDueAfter(RequestUtil.getDate(requestParams, "dueAfter"));
}

if (requestParams.containsKey("withoutDueDate") && Boolean.parseBoolean(requestParams.get("withoutDueDate"))) {
request.setWithoutDueDate(Boolean.TRUE);
}

if (requestParams.containsKey("active")) {
request.setActive(Boolean.valueOf(requestParams.get("active")));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
@Api(tags = { "Runtime" }, authorizations = { @Authorization(value = "basicAuth") })
public class VariableInstanceCollectionResource extends VariableInstanceBaseResource {

@ApiOperation(value = "List of variable instances", tags = { "History" }, nickname = "listVariableInstances")
@ApiOperation(value = "List of variable instances", tags = { "History" }, nickname = "listVariableInstances", notes = "For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').")
@ApiImplicitParams({
@ApiImplicitParam(name = "caseInstanceId", dataType = "string", value = "The case instance id of the variable instance.", paramType = "query"),
@ApiImplicitParam(name = "taskId", dataType = "string", value = "The task id of the variable instance.", paramType = "query"),
Expand Down
Loading