api

func (*DeploymentEndpoints) CreateDeployment ¶ added in v0.0.16

func (this *DeploymentEndpoints) CreateDeployment(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

CreateDeployment godoc @Summary deploy process @Description deploy process; prepared process may be requested from the process-fog-deployment service @Tags deployment @Produce json @Security Bearer @Param message body deploymentmodel.Deployment true "deployment" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /deployments/{networkId} [POST]

func (*DeploymentEndpoints) DeleteDeployment ¶ added in v0.0.16

func (this *DeploymentEndpoints) DeleteDeployment(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

DeleteDeployment godoc @Summary delete deployment @Description delete deployment @Tags deployment @Produce json @Security Bearer @Param networkId path string true "network id" @Param deploymentId path string true "deployment id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /deployments/{networkId}/{deploymentId} [DELETE]

func (*DeploymentEndpoints) GetDeployment ¶ added in v0.0.16

func (this *DeploymentEndpoints) GetDeployment(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

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

func (*DeploymentEndpoints) GetDeploymentMetadata ¶ added in v0.0.16

func (this *DeploymentEndpoints) GetDeploymentMetadata(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

GetDeploymentMetadata godoc @Summary get deployment metadata @Description get deployment metadata @Tags deployment, metadata @Produce json @Security Bearer @Param networkId path string true "network id" @Param deploymentId path string true "deployment id" @Success 200 {object} model.DeploymentMetadata @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /deployments/{networkId}/{deploymentId}/metadata [GET]

func (*DeploymentEndpoints) ListDeployments ¶ added in v0.0.16

func (this *DeploymentEndpoints) ListDeployments(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

ListDeployments godoc @Summary list deployments @Description list deployments @Tags deployment @Produce json @Security Bearer @Param networkId path string true "network id" @Param deploymentId path string true "deployment id" @Param search query string false "search" @Param limit query integer false "default 100" @Param offset query integer false "default 0" @Param sort query string false "default id.asc" @Param extended query bool false "add the fields 'diagram', 'definition_id' and 'error' to the results" @Param network_id query string true "comma seperated list of network-ids used to filter the deployments" @Success 200 {array} model.Deployment @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /deployments [GET]

func (*DeploymentEndpoints) StartDeployment ¶ added in v0.0.16

func (this *DeploymentEndpoints) StartDeployment(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

StartDeployment godoc @Summary start deployed process @Description start deployed process; a process may expect parameters on start. these cna be passed as query parameters. swagger allows no arbitrary/dynamic parameter names, which means a query wit parameters must be executed manually @Tags deployment @Produce json @Security Bearer @Param networkId path string true "network id" @Param deploymentId path string true "deployment id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /deployments/{networkId}/{deploymentId}/start [GET]

func (*HistoryEndpoints) DeleteHistoricProcessInstance ¶ added in v0.0.16

func (this *HistoryEndpoints) DeleteHistoricProcessInstance(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

DeleteHistoricProcessInstance godoc @Summary get historic process-instances @Description get historic process-instances @Tags process-instance @Produce json @Security Bearer @Param networkId path string true "network id" @Param id path string true "instance id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /history/process-instances/{networkId}/{id} [DELETE]

func (*HistoryEndpoints) GetHistoricProcessInstance ¶ added in v0.0.16

func (this *HistoryEndpoints) GetHistoricProcessInstance(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

GetHistoricProcessInstance godoc @Summary get historic process-instances @Description get historic process-instances @Tags process-instance @Produce json @Security Bearer @Param networkId path string true "network id" @Param id path string true "instance id" @Success 200 {object} model.HistoricProcessInstance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /history/process-instances/{networkId}/{id} [GET]

func (*HistoryEndpoints) ListHistoricProcessInstances ¶ added in v0.0.16

func (this *HistoryEndpoints) ListHistoricProcessInstances(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

ListHistoricProcessInstances godoc @Summary list historic process-instances @Description list historic process-instances @Tags process-instance @Produce json @Security Bearer @Param search query string false "search" @Param limit query integer false "default 100" @Param offset query integer false "default 0" @Param sort query string false "default id.asc" @Param network_id query string true "comma seperated list of network-ids, used to filter the result" @Param processDefinitionId query string false "process-definition-id, used to filter the result" @Param state query string false "state may be 'finished' or 'unfinished', used to filter the result" @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 /history/process-instances [GET]

func (*IncidentEndpoints) DeleteIncident ¶ added in v0.0.16

func (this *IncidentEndpoints) DeleteIncident(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

DeleteIncident godoc @Summary delete incident @Description delete incident @Tags incidents @Produce json @Security Bearer @Param networkId path string true "network id" @Param id path string true "incident id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /incidents/{networkId}/{id} [DELETE]

func (*IncidentEndpoints) GetIncident ¶ added in v0.0.16

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

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

func (*IncidentEndpoints) ListIncidents ¶ added in v0.0.16

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

ListIncidents godoc @Summary list incidents @Description list incidents @Tags incidents @Produce json @Security Bearer @Param limit query integer false "default 100" @Param offset query integer false "default 0" @Param sort query string false "default id.asc" @Param network_id query string true "comma seperated list of network-ids, used to filter the result" @Param process_instance_id query string false "process-instance-id, used to filter the result" @Success 200 {array} model.Incident @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /incidents [GET]

func (*MetadataEndpoints) ListMetadata ¶ added in v0.0.16

func (this *MetadataEndpoints) ListMetadata(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

ListMetadata godoc @Summary list deployment metadata @Description list deployment metadata @Tags deployment, metadata @Produce json @Security Bearer @Param networkId path string true "network id" @Param deployment_id query string false "deployment id" @Param camunda_deployment_id query string false "camunda deployment id" @Success 200 {array} model.DeploymentMetadata @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /metadata/{networkId} [GET]

func (*NetworksEndpoints) ListNetworks ¶ added in v0.0.16

func (this *NetworksEndpoints) ListNetworks(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

ListNetworks godoc @Summary list networks @Description list networks @Tags networks @Produce json @Security Bearer @Success 200 {array} models.Hub @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /networks [GET]

func (*ProcessDefinitionEndpoints) GetProcessDefinition ¶ added in v0.0.16

func (this *ProcessDefinitionEndpoints) GetProcessDefinition(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

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

func (*ProcessDefinitionEndpoints) ListProcessDefinitions ¶ added in v0.0.16

func (this *ProcessDefinitionEndpoints) ListProcessDefinitions(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

ListProcessDefinitions godoc @Summary list process-definitions @Description list process-definitions @Tags process-definitions @Produce json @Security Bearer @Param limit query integer false "default 100" @Param offset query integer false "default 0" @Param sort query string false "default id.asc" @Param network_id query string true "comma seperated list of network-ids used to filter" @Success 200 {array} model.ProcessDefinition @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /process-definitions [GET]

func (*ProcessInstanceEndpoints) DeleteProcessInstance ¶ added in v0.0.16

func (this *ProcessInstanceEndpoints) DeleteProcessInstance(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

DeleteProcessInstance godoc @Summary get process-instances @Description get process-instances @Tags process-instance @Produce json @Security Bearer @Param networkId path string true "network id" @Param id path string true "instance id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /process-instances/{networkId}/{id} [DELETE]

func (*ProcessInstanceEndpoints) GetProcessInstance ¶ added in v0.0.16

func (this *ProcessInstanceEndpoints) GetProcessInstance(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

GetProcessInstance godoc @Summary get process-instances @Description get process-instances @Tags process-instance @Produce json @Security Bearer @Param networkId path string true "network id" @Param id path string true "instance id" @Success 200 {object} model.HistoricProcessInstance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /process-instances/{networkId}/{id} [GET]

func (*ProcessInstanceEndpoints) ListProcessInstances ¶ added in v0.0.16

func (this *ProcessInstanceEndpoints) ListProcessInstances(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

ListProcessInstances godoc @Summary list process-instances @Description list process-instances @Tags process-instance @Produce json @Security Bearer @Param limit query integer false "default 100" @Param offset query integer false "default 0" @Param sort query string false "default id.asc" @Param network_id query string true "comma seperated list of network-ids used to filter" @Success 200 {array} model.ProcessInstance @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /process-instances [GET]

func (*Swagger) Swagger ¶ added in v0.0.16

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

func (*SyncEndpoints) ReSyncDeployments ¶ added in v0.0.16

func (this *SyncEndpoints) ReSyncDeployments(config configuration.Config, ctrl *controller.Controller, router *http.ServeMux)

ReSyncDeployments godoc @Summary resync deployments @Description resync deployments that are registered as lost on the mgw side. can only be tried once. @Tags deployment @Produce json @Security Bearer @Param networkId path string true "network id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /sync/deployments/{networkId} [POST]