org.camunda.bpm.engine.rest.ProcessInstanceRestService Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.camunda.bpm.engine.rest;
import java.util.List;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.UriInfo;
import org.camunda.bpm.engine.batch.Batch;
import org.camunda.bpm.engine.rest.dto.CountResultDto;
import org.camunda.bpm.engine.rest.dto.batch.BatchDto;
import org.camunda.bpm.engine.rest.dto.runtime.ProcessInstanceDto;
import org.camunda.bpm.engine.rest.dto.runtime.ProcessInstanceQueryDto;
import org.camunda.bpm.engine.rest.dto.runtime.ProcessInstanceSuspensionStateDto;
import org.camunda.bpm.engine.rest.dto.runtime.SetJobRetriesByProcessDto;
import org.camunda.bpm.engine.rest.dto.runtime.batch.DeleteProcessInstancesDto;
import org.camunda.bpm.engine.rest.sub.runtime.ProcessInstanceResource;
import org.camunda.bpm.engine.runtime.ProcessInstanceQuery;
@Produces(MediaType.APPLICATION_JSON)
public interface ProcessInstanceRestService {
public static final String PATH = "/process-instance";
@Path("/{id}")
ProcessInstanceResource getProcessInstance(@PathParam("id") String processInstanceId);
/**
* Exposes the {@link ProcessInstanceQuery} interface as a REST service.
*
* @param uriInfo
* @param firstResult
* @param maxResults
* @return
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
List getProcessInstances(@Context UriInfo uriInfo,
@QueryParam("firstResult") Integer firstResult,
@QueryParam("maxResults") Integer maxResults);
/**
* Expects the same parameters as
* {@link ProcessInstanceRestService#getProcessInstances(UriInfo, Integer, Integer)} (as a JSON message body)
* and allows for any number of variable checks.
*
* @param query
* @param firstResult
* @param maxResults
* @return
*/
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
List queryProcessInstances(ProcessInstanceQueryDto query,
@QueryParam("firstResult") Integer firstResult,
@QueryParam("maxResults") Integer maxResults);
@GET
@Path("/count")
@Produces(MediaType.APPLICATION_JSON)
CountResultDto getProcessInstancesCount(@Context UriInfo uriInfo);
@POST
@Path("/count")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
CountResultDto queryProcessInstancesCount(ProcessInstanceQueryDto query);
@PUT
@Path("/suspended")
@Consumes(MediaType.APPLICATION_JSON)
void updateSuspensionState(ProcessInstanceSuspensionStateDto dto);
@POST
@Path("/suspended-async")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
BatchDto updateSuspensionStateAsync(ProcessInstanceSuspensionStateDto dto);
@POST
@Path("/delete")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
BatchDto deleteAsync(DeleteProcessInstancesDto dto);
@POST
@Path("/delete-historic-query-based")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
BatchDto deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto dto);
@POST
@Path("/job-retries")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
BatchDto setRetriesByProcess(SetJobRetriesByProcessDto setJobRetriesDto);
@POST
@Path("/job-retries-historic-query-based")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
BatchDto setRetriesByProcessHistoricQueryBased(SetJobRetriesByProcessDto setJobRetriesDto);
}