api

func (*FactoryType) Start ¶

func (this *FactoryType) Start(ctx context.Context, config configuration.Config, ctrl interfaces.Controller) error

func (*IncidentsEndpoints) CreateIncident ¶ added in v0.0.8

func (this *IncidentsEndpoints) CreateIncident(config configuration.Config, ctrl interfaces.Controller, router *http.ServeMux)

CreateIncident godoc @Summary create incident @Description create incident, user must be admin @Tags incidents @Produce json @Security Bearer @Param message body messages.IncidentMessage true "Incident" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /incidents [POST]

func (*IncidentsEndpoints) DeleteIncidentByProcessDefinitionId ¶ added in v0.0.8

func (this *IncidentsEndpoints) DeleteIncidentByProcessDefinitionId(config configuration.Config, ctrl interfaces.Controller, router *http.ServeMux)

DeleteIncidentByProcessDefinitionId godoc @Summary delete incidents by process-definition id @Description delete incidents by process-definition id, user must be admin @Tags incidents @Produce json @Security Bearer @Param id path string true "process-definition id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /process-definitions/{id} [DELETE]

func (*IncidentsEndpoints) DeleteIncidentByProcessInstanceId ¶ added in v0.0.8

func (this *IncidentsEndpoints) DeleteIncidentByProcessInstanceId(config configuration.Config, ctrl interfaces.Controller, router *http.ServeMux)

DeleteIncidentByProcessInstanceId godoc @Summary delete incidents by process-instance id @Description delete incidents by process-instance id, user must be admin @Tags incidents @Produce json @Security Bearer @Param id path string true "process-instance id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /process-instances/{id} [DELETE]

func (*IncidentsEndpoints) GetIncident ¶ added in v0.0.8

func (this *IncidentsEndpoints) GetIncident(config configuration.Config, ctrl interfaces.Controller, router *http.ServeMux)

GetIncident godoc @Summary get incident @Description get incident @Tags incidents @Produce json @Security Bearer @Param id path string true "Incident Id" @Success 200 {object} messages.IncidentMessage @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /incidents/{id} [GET]

func (*IncidentsEndpoints) ListIncidents ¶ added in v0.0.8

func (this *IncidentsEndpoints) ListIncidents(config configuration.Config, ctrl interfaces.Controller, router *http.ServeMux)

ListIncidents godoc @Summary list incidents @Description list incidents @Tags incidents @Produce json @Security Bearer @Param limit query integer false "limits size of result; default 100" @Param offset query integer false "offset to be used in combination with limit, default 0" @Param sort query string false "default id.asc, sortable by id, external_task_id, process_instance_id, process_definition_id, time" @Param process_definition_id query string false "filter by process_definition_id" @Param process_instance_id query string false "filter by process_instance_id" @Param external_task_id query string false "filter by external_task_id" @Success 200 {array} messages.IncidentMessage @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /incidents [GET]

func (*IncidentsEndpoints) SetIncidentHandler ¶ added in v0.0.8

func (this *IncidentsEndpoints) SetIncidentHandler(config configuration.Config, ctrl interfaces.Controller, router *http.ServeMux)

SetIncidentHandler godoc @Summary set on incident handler @Description set on incident handler, user must be admin @Tags incidents @Produce json @Security Bearer @Param message body messages.OnIncident true "Incident-Handler" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /on-incident-handler [PUT]

func (*SwaggerEndpoints) Swagger ¶ added in v0.0.8

func (this *SwaggerEndpoints) Swagger(config configuration.Config, ctrl interfaces.Controller, router *http.ServeMux)