api

package
v1.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 14, 2025 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetRouter 

func GetRouter(config configuration.Config, camunda *camunda.Camunda, ctrl *controller.Controller, m Metrics) http.Handler

GetRouter doc @title Process-Engine-Wrapper @version 0.1 @license.name Apache 2.0 @license.url http://www.apache.org/licenses/LICENSE-2.0.html @BasePath / @securityDefinitions.apikey Bearer @in header @name Authorization @description Type "Bearer" followed by a space and JWT token.

func Start 

func Start(ctx context.Context, config configuration.Config, camunda *camunda.Camunda, ctrl *controller.Controller, m Metrics) (err error)

Types

type DeployEndpoints added in v1.0.0 

type DeployEndpoints struct{}

func (*DeployEndpoints) DeleteDeployment added in v1.0.0 

func (this *DeployEndpoints) DeleteDeployment(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

DeleteDeployment godoc @Summary delete deployment @Description delete deployment, meant for internal use by the process-deployment service, only admins may access this endpoint @Tags deployment @Security Bearer @Param deplid path string true "deployment id" @Param userid path string true "user id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /process-deployments/{userid}/{deplid} [DELETE]

func (*DeployEndpoints) Deploy added in v1.0.0 

func (this *DeployEndpoints) Deploy(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

Deploy godoc @Summary deploy process @Description deploy process, meant for internal use by the process-deployment service, only admins may access this endpoint @Tags deployment @Security Bearer @Param message body model.DeploymentMessage true "deployment" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /process-deployments [PUT]

type EndpointMethod added in v0.0.9 

type EndpointMethod = func(config configuration.Config, router *http.ServeMux, camunda *camunda.Camunda, ctrl *controller.Controller, m Metrics)

type EventTriggerMessage added in v0.0.9 

type EventTriggerMessage struct {
	MessageName           string `json:"messageName"`
	ProcessVariablesLocal map[string]struct {
		Type  string      `json:"type,omitempty"`
		Value interface{} `json:"value,omitempty"`
	} `json:"processVariablesLocal"`
	ResultEnabled bool   `json:"resultEnabled"`
	TenantId      string `json:"tenantId"`
}

ref https://docs.camunda.org/rest/camunda-bpm-platform/7.23-SNAPSHOT/#tag/Message/operation/deliverMessage

type Metrics 

type Metrics interface {
	NotifyEventTrigger()
}

type Swagger added in v0.0.9 

type Swagger struct{}

func (*Swagger) Swagger added in v0.0.9 

func (this *Swagger) Swagger(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

type V1Endpoints 

type V1Endpoints struct{}

func (*V1Endpoints) DeleteHistoricPricessInstance added in v0.0.9 

func (this *V1Endpoints) DeleteHistoricPricessInstance(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) DeleteProcessInstance added in v0.0.9 

func (this *V1Endpoints) DeleteProcessInstance(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) DeploymentExists added in v0.0.9 

func (this *V1Endpoints) DeploymentExists(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) FindFinishedProcessInstances added in v0.0.9 

func (this *V1Endpoints) FindFinishedProcessInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) FindUnfinishedProcessInstances added in v0.0.9 

func (this *V1Endpoints) FindUnfinishedProcessInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetDeployment added in v0.0.9 

func (this *V1Endpoints) GetDeployment(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetDeploymentDefinition added in v0.0.9 

func (this *V1Endpoints) GetDeploymentDefinition(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetDeploymentParameters added in v0.0.9 

func (this *V1Endpoints) GetDeploymentParameters(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetDeployments added in v0.0.9 

func (this *V1Endpoints) GetDeployments(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetFilteredHistoricProcessInstances added in v0.0.9 

func (this *V1Endpoints) GetFilteredHistoricProcessInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetFinishedProcessInstances added in v0.0.9 

func (this *V1Endpoints) GetFinishedProcessInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetFinishedProcessInstancesOfProcessDefinition added in v0.0.9 

func (this *V1Endpoints) GetFinishedProcessInstancesOfProcessDefinition(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetHistoricProcessInstances added in v0.0.9 

func (this *V1Endpoints) GetHistoricProcessInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetHistoricProcessInstancesOfProcessDefinition added in v0.0.9 

func (this *V1Endpoints) GetHistoricProcessInstancesOfProcessDefinition(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetProcessDefinition added in v0.0.9 

func (this *V1Endpoints) GetProcessDefinition(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetProcessDefinitionDiagram added in v0.0.9 

func (this *V1Endpoints) GetProcessDefinitionDiagram(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetProcessInstanceCount added in v0.0.9 

func (this *V1Endpoints) GetProcessInstanceCount(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetProcessInstances added in v0.0.9 

func (this *V1Endpoints) GetProcessInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetUnfinishedProcessInstances added in v0.0.9 

func (this *V1Endpoints) GetUnfinishedProcessInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) GetUnfinishedProcessInstancesOfProcessDefinition added in v0.0.9 

func (this *V1Endpoints) GetUnfinishedProcessInstancesOfProcessDefinition(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) HealthCheck added in v0.0.9 

func (this *V1Endpoints) HealthCheck(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) StartDeployment added in v0.0.9 

func (this *V1Endpoints) StartDeployment(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) StartProcessDefinition added in v0.0.9 

func (this *V1Endpoints) StartProcessDefinition(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

func (*V1Endpoints) StartProcessDefinitionAndGetInstanceId added in v0.0.9 

func (this *V1Endpoints) StartProcessDefinitionAndGetInstanceId(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

type V2Endpoints 

type V2Endpoints struct{}

func (*V2Endpoints) DeleteHistoricProcessInstance added in v0.0.9 

func (this *V2Endpoints) DeleteHistoricProcessInstance(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

DeleteHistoricProcessInstance godoc @Summary delete historic process-instance @Description delete historic process-instance @Tags process-instance @Security Bearer @Param id path string true "process-instance id" @Success 200 @Failure 400 @Failure 500 @Router /v2/history/process-instances/{id} [DELETE]

func (*V2Endpoints) DeleteMultipleHistoricProcessInstances added in v0.0.9 

func (this *V2Endpoints) DeleteMultipleHistoricProcessInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

DeleteMultipleHistoricProcessInstances godoc @Summary delete multiple historic process-instances @Description delete multiple historic process-instances @Tags process-instance @Security Bearer @Param message body []string true "ids" @Success 200 @Failure 400 @Failure 500 @Router /v2/process-instances [DELETE]

func (*V2Endpoints) DeleteProcessInstance added in v0.0.9 

func (this *V2Endpoints) DeleteProcessInstance(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

DeleteProcessInstance godoc @Summary delete process-instance @Description delete process-instance @Tags process-instance @Security Bearer @Param id path string true "process-instance id" @Success 200 @Failure 400 @Failure 500 @Router /v2/process-instances/{id} [DELETE]

func (*V2Endpoints) DeleteProcessMultipleInstances added in v0.0.9 

func (this *V2Endpoints) DeleteProcessMultipleInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

DeleteProcessMultipleInstances godoc @Summary delete multiple process-instances @Description delete multiple process-instances @Tags process-instance @Security Bearer @Param message body []string true "ids" @Success 200 @Failure 400 @Failure 500 @Router /v2/process-instances [DELETE]

func (*V2Endpoints) DeploymentExists added in v0.0.9 

func (this *V2Endpoints) DeploymentExists(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

DeploymentExists godoc @Summary deployment exists @Description deployment exists @Tags deployment @Produce json @Security Bearer @Param id path string true "deployment id" @Success 200 {object} bool @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/deployments/{id}/exists [GET]

func (*V2Endpoints) GetDeployment added in v0.0.9 

func (this *V2Endpoints) GetDeployment(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

GetDeployment godoc @Summary get deployment @Description get process deployment by id @Tags deployment @Produce json @Security Bearer @Param id path string true "deployment id" @Success 200 {object} model.CamundaDeployment @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/deployments/{id} [GET]

func (*V2Endpoints) GetDeploymentDefinition added in v0.0.9 

func (this *V2Endpoints) GetDeploymentDefinition(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

GetDeploymentDefinition godoc @Summary get deployment process-definition @Description get deployment process-definition @Tags deployment, process-definition @Produce json @Security Bearer @Param id path string true "deployment id" @Success 200 {object} model.ProcessDefinition @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/deployments/{id}/definition [GET]

func (*V2Endpoints) GetDeploymentInstances added in v0.0.9 

func (this *V2Endpoints) GetDeploymentInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

GetDeploymentInstances godoc @Summary get deployment process-instances @Description get deployment process-instances @Tags deployment, process-instance @Produce json @Security Bearer @Param id path string true "deployment id" @Success 200 {array} model.ProcessInstance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/deployments/{id}/instances [GET]

func (*V2Endpoints) GetDeploymentParameters added in v0.0.9 

func (this *V2Endpoints) GetDeploymentParameters(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

GetDeploymentParameters godoc @Summary get deployment parameter @Description get deployment start parameter @Tags start, deployment @Produce json @Security Bearer @Param id path string true "deployment id" @Success 200 {object} model.VariableMap @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/deployments/{id}/parameter [GET]

func (*V2Endpoints) GetHistoricProcessInstances added in v0.0.9 

func (this *V2Endpoints) GetHistoricProcessInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

GetHistoricProcessInstances godoc @Summary list historic process-instances @Description list historic process-instances @Tags process-instance @Produce json @Security Bearer @Param with_total query bool false "if set to true, wraps the result in an objet with the result {total:0, data:[]}" @Success 200 {array} model.HistoricProcessInstance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/history/process-instances [GET]

func (*V2Endpoints) GetProcessDefinition added in v0.0.9 

func (this *V2Endpoints) GetProcessDefinition(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

GetProcessDefinition godoc @Summary get process-definition @Description get process-definition @Tags process-definition @Produce json @Security Bearer @Param id path string true "process-definition id" @Success 200 {object} model.ProcessDefinition @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/process-definitions/{id} [GET]

func (*V2Endpoints) GetProcessDefinitionDiagram added in v0.0.9 

func (this *V2Endpoints) GetProcessDefinitionDiagram(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

GetProcessDefinitionDiagram godoc @Summary get process-definition diagram @Description get process-definition diagram @Tags process-definition @Produce json @Security Bearer @Param id path string true "process-definition id" @Success 200 {object} string @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/process-definitions/{id}/diagram [GET]

func (*V2Endpoints) GetProcessInstanceCount added in v0.0.9 

func (this *V2Endpoints) GetProcessInstanceCount(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

GetProcessInstanceCount godoc @Summary process-instance count @Description process-instance count @Tags process-instance @Produce json @Security Bearer @Success 200 {object} int @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/process-instances/count [GET]

func (*V2Endpoints) ListDeployments added in v0.0.9 

func (this *V2Endpoints) ListDeployments(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

ListDeployments godoc @Summary list deployments @Description list deployments @Tags deployment @Produce json @Security Bearer @Success 200 {array} model.ExtendedDeployment @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/deployments [GET]

func (*V2Endpoints) ListProcessInstances added in v0.0.9 

func (this *V2Endpoints) ListProcessInstances(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

ListProcessInstances godoc @Summary list process-instances @Description list process-instances @Tags process-instance @Produce json @Security Bearer @Success 200 {array} model.ProcessInstance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/process-instances [GET]

func (*V2Endpoints) SetProcessInstanceVariable added in v0.0.9 

func (this *V2Endpoints) SetProcessInstanceVariable(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

SetProcessInstanceVariable godoc @Summary set process-instance variable @Description set process-instance variable @Tags process-instance @Security Bearer @Param id path string true "process-instance id" @Param variable_name path string true "variable_name" @Param message body interface{} true "value" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/process-instances/{id}/variables/{variable_name} [PUT]

func (*V2Endpoints) StartDeployment added in v0.0.9 

func (this *V2Endpoints) StartDeployment(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

StartDeployment godoc @Summary start deployment @Description start deployment by id @Tags start, deployment @Produce json @Security Bearer @Param id path string true "deployment id" @Success 200 {object} model.ProcessInstance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/deployments/{id}/start [GET]

func (*V2Endpoints) StartProcessDefinition added in v0.0.9 

func (this *V2Endpoints) StartProcessDefinition(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

StartProcessDefinition godoc @Summary start process-definitions @Description start process-definitions by id @Tags start, process-definitions @Produce json @Security Bearer @Param id path string true "process-definitions id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/process-definitions/{id}/start [GET]

func (*V2Endpoints) StartProcessDefinitionAndGetInstanceId added in v0.0.9 

func (this *V2Endpoints) StartProcessDefinitionAndGetInstanceId(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

StartProcessDefinitionAndGetInstanceId godoc @Summary start process-definitions and get instance @Description start process-definitions and get started process-instance @Tags start, process-definitions @Produce json @Security Bearer @Param id path string true "process-definitions id" @Success 200 {object} model.ProcessInstance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/process-definitions/{id}/start/id [GET]

func (*V2Endpoints) TriggerEvent added in v0.0.9 

func (this *V2Endpoints) TriggerEvent(config configuration.Config, router *http.ServeMux, c *camunda.Camunda, e *controller.Controller, m Metrics)

TriggerEvent godoc @Summary trigger event @Description trigger event @Tags event @Produce json @Security Bearer @Param message body EventTriggerMessage true "ref https://docs.camunda.org/rest/camunda-bpm-platform/7.23-SNAPSHOT/#tag/Message/operation/deliverMessage" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/event-trigger [POST]

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.