gocamunda

package module
v0.0.0-...-8aadebc Latest Latest
Warning

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

Go to latest
Published: Sep 7, 2020 License: Apache-2.0 Imports: 21 Imported by: 0

README

Go API client for gocamunda

OpenApi Spec for Camunda BPM REST API.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 7.13.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./gocamunda"

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/engine-rest

Class Method HTTP request Description
ConditionApi EvaluateCondition Post /condition
DeploymentApi CreateDeployment Post /deployment/create
DeploymentApi DeleteDeployment Delete /deployment/{id}
DeploymentApi GetDeployment Get /deployment/{id}
DeploymentApi GetDeploymentResource Get /deployment/{id}/resources/{resourceId}
DeploymentApi GetDeploymentResourceData Get /deployment/{id}/resources/{resourceId}/data
DeploymentApi GetDeploymentResources Get /deployment/{id}/resources
DeploymentApi GetDeployments Get /deployment
DeploymentApi GetDeploymentsCount Get /deployment/count
DeploymentApi Redeploy Post /deployment/{id}/redeploy
EngineApi GetProcessEngineNames Get /engine
EventSubscriptionApi GetEventSubscriptions Get /event-subscription
EventSubscriptionApi GetEventSubscriptionsCount Get /event-subscription/count
ExternalTaskApi CompleteExternalTaskResource Post /external-task/{id}/complete
ExternalTaskApi ExtendLock Post /external-task/{id}/extendLock
ExternalTaskApi FetchAndLock Post /external-task/fetchAndLock
ExternalTaskApi GetExternalTask Get /external-task/{id}
ExternalTaskApi GetExternalTaskErrorDetails Get /external-task/{id}/errorDetails
ExternalTaskApi GetExternalTasks Get /external-task
ExternalTaskApi GetExternalTasksCount Get /external-task/count
ExternalTaskApi GetTopicNames Get /external-task/topic-names
ExternalTaskApi HandleExternalTaskBpmnError Post /external-task/{id}/bpmnError
ExternalTaskApi HandleFailure Post /external-task/{id}/failure
ExternalTaskApi QueryExternalTasks Post /external-task
ExternalTaskApi QueryExternalTasksCount Post /external-task/count
ExternalTaskApi SetExternalTaskResourcePriority Put /external-task/{id}/priority
ExternalTaskApi SetExternalTaskResourceRetries Put /external-task/{id}/retries
ExternalTaskApi SetExternalTaskRetries Put /external-task/retries
ExternalTaskApi SetExternalTaskRetriesAsyncOperation Post /external-task/retries-async
ExternalTaskApi Unlock Post /external-task/{id}/unlock
MessageApi DeliverMessage Post /message
MetricsApi GetMetrics Get /metrics/{metrics-name}/sum
MetricsApi Interval Get /metrics
ProcessDefinitionApi DeleteProcessDefinition Delete /process-definition/{id} Delete
ProcessDefinitionApi DeleteProcessDefinitionsByKey Delete /process-definition/key/{key} Delete By Key
ProcessDefinitionApi DeleteProcessDefinitionsByKeyAndTenantId Delete /process-definition/key/{key}/tenant/{tenant-id} Delete By Key
ProcessDefinitionApi GetActivityStatistics Get /process-definition/{id}/statistics Get Activity Instance Statistics
ProcessDefinitionApi GetActivityStatisticsByProcessDefinitionKey Get /process-definition/key/{key}/statistics Get Activity Instance Statistics
ProcessDefinitionApi GetActivityStatisticsByProcessDefinitionKeyAndTenantId Get /process-definition/key/{key}/tenant/{tenant-id}/statistics Get Activity Instance Statistics
ProcessDefinitionApi GetDeployedStartForm Get /process-definition/{id}/deployed-start-form Get Deployed Start Form
ProcessDefinitionApi GetDeployedStartFormByKey Get /process-definition/key/{key}/deployed-start-form Get Deployed Start Form
ProcessDefinitionApi GetDeployedStartFormByKeyAndTenantId Get /process-definition/key/{key}/tenant/{tenant-id}/deployed-start-form Get Deployed Start Form
ProcessDefinitionApi GetLatestProcessDefinitionByTenantId Get /process-definition/key/{key}/tenant/{tenant-id} Get
ProcessDefinitionApi GetProcessDefinition Get /process-definition/{id} Get
ProcessDefinitionApi GetProcessDefinitionBpmn20Xml Get /process-definition/{id}/xml Get XML
ProcessDefinitionApi GetProcessDefinitionBpmn20XmlByKey Get /process-definition/key/{key}/xml Get XML
ProcessDefinitionApi GetProcessDefinitionBpmn20XmlByKeyAndTenantId Get /process-definition/key/{key}/tenant/{tenant-id}/xml Get XML
ProcessDefinitionApi GetProcessDefinitionByKey Get /process-definition/key/{key} Get
ProcessDefinitionApi GetProcessDefinitionDiagram Get /process-definition/{id}/diagram Get Diagram
ProcessDefinitionApi GetProcessDefinitionDiagramByKey Get /process-definition/key/{key}/diagram Get Diagram
ProcessDefinitionApi GetProcessDefinitionDiagramByKeyAndTenantId Get /process-definition/key/{key}/tenant/{tenant-id}/diagram Get Diagram
ProcessDefinitionApi GetProcessDefinitionStatistics Get /process-definition/statistics Get Process Instance Statistics
ProcessDefinitionApi GetProcessDefinitions Get /process-definition Get List
ProcessDefinitionApi GetProcessDefinitionsCount Get /process-definition/count Get List Count
ProcessDefinitionApi GetRenderedStartForm Get /process-definition/{id}/rendered-form Get Rendered Start Form
ProcessDefinitionApi GetRenderedStartFormByKey Get /process-definition/key/{key}/rendered-form Get Rendered Start Form
ProcessDefinitionApi GetRenderedStartFormByKeyAndTenantId Get /process-definition/key/{key}/tenant/{tenant-id}/rendered-form Get Rendered Start Form
ProcessDefinitionApi GetStartForm Get /process-definition/{id}/startForm Get Start Form Key
ProcessDefinitionApi GetStartFormByKey Get /process-definition/key/{key}/startForm Get Start Form Key
ProcessDefinitionApi GetStartFormByKeyAndTenantId Get /process-definition/key/{key}/tenant/{tenant-id}/startForm Get Start Form Key
ProcessDefinitionApi GetStartFormVariables Get /process-definition/{id}/form-variables Get Start Form Variables
ProcessDefinitionApi GetStartFormVariablesByKey Get /process-definition/key/{key}/form-variables Get Start Form Variables
ProcessDefinitionApi GetStartFormVariablesByKeyAndTenantId Get /process-definition/key/{key}/tenant/{tenant-id}/form-variables Get Start Form Variables
ProcessDefinitionApi RestartProcessInstance Post /process-definition/{id}/restart Restart Process Instance
ProcessDefinitionApi RestartProcessInstanceAsyncOperation Post /process-definition/{id}/restart-async Restart Process Instance Async
ProcessDefinitionApi StartProcessInstance Post /process-definition/{id}/start Start Instance
ProcessDefinitionApi StartProcessInstanceByKey Post /process-definition/key/{key}/start Start Instance
ProcessDefinitionApi StartProcessInstanceByKeyAndTenantId Post /process-definition/key/{key}/tenant/{tenant-id}/start Start Instance
ProcessDefinitionApi SubmitForm Post /process-definition/{id}/submit-form Submit Start Form
ProcessDefinitionApi SubmitFormByKey Post /process-definition/key/{key}/submit-form Submit Start Form
ProcessDefinitionApi SubmitFormByKeyAndTenantId Post /process-definition/key/{key}/tenant/{tenant-id}/submit-form Submit Start Form
ProcessDefinitionApi UpdateHistoryTimeToLiveByProcessDefinitionId Put /process-definition/{id}/history-time-to-live Update History Time to Live
ProcessDefinitionApi UpdateHistoryTimeToLiveByProcessDefinitionKey Put /process-definition/key/{key}/history-time-to-live Update History Time to Live
ProcessDefinitionApi UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId Put /process-definition/key/{key}/tenant/{tenant-id}/history-time-to-live Update History Time to Live
ProcessDefinitionApi UpdateProcessDefinitionSuspensionState Put /process-definition/suspended Activate/Suspend By Key
ProcessDefinitionApi UpdateProcessDefinitionSuspensionStateById Put /process-definition/{id}/suspended Activate/Suspend By Id
ProcessDefinitionApi UpdateProcessDefinitionSuspensionStateByKey Put /process-definition/key/{key}/suspended Activate/Suspend by Id
ProcessDefinitionApi UpdateProcessDefinitionSuspensionStateByKeyAndTenantId Put /process-definition/key/{key}/tenant/{tenant-id}/suspended Activate/Suspend by Id
ProcessInstanceApi DeleteAsyncHistoricQueryBased Post /process-instance/delete-historic-query-based
ProcessInstanceApi DeleteProcessInstance Delete /process-instance/{id}
ProcessInstanceApi DeleteProcessInstanceVariable Delete /process-instance/{id}/variables/{varName}
ProcessInstanceApi DeleteProcessInstancesAsyncOperation Post /process-instance/delete
ProcessInstanceApi GetActivityInstanceTree Get /process-instance/{id}/activity-instances
ProcessInstanceApi GetProcessInstanceVariable Get /process-instance/{id}/variables/{varName}
ProcessInstanceApi GetProcessInstanceVariableBinary Get /process-instance/{id}/variables/{varName}/data
ProcessInstanceApi GetProcessInstanceVariables Get /process-instance/{id}/variables
ProcessInstanceApi GetProcessInstances Get /process-instance
ProcessInstanceApi GetProcessInstancesCount Get /process-instance/count
ProcessInstanceApi ModifyProcessInstance Post /process-instance/{id}/modification
ProcessInstanceApi ModifyProcessInstanceAsyncOperation Post /process-instance/{id}/modification-async
ProcessInstanceApi ModifyProcessInstanceVariables Post /process-instance/{id}/variables
ProcessInstanceApi QueryProcessInstances Post /process-instance
ProcessInstanceApi QueryProcessInstancesCount Post /process-instance/count
ProcessInstanceApi SetProcessInstanceVariable Put /process-instance/{id}/variables/{varName}
ProcessInstanceApi SetProcessInstanceVariableBinary Post /process-instance/{id}/variables/{varName}/data
ProcessInstanceApi SetRetriesByProcess Post /process-instance/job-retries
ProcessInstanceApi SetRetriesByProcessHistoricQueryBased Post /process-instance/job-retries-historic-query-based
ProcessInstanceApi UpdateSuspensionState Put /process-instance/suspended
ProcessInstanceApi UpdateSuspensionStateAsyncOperation Post /process-instance/suspended-async
ProcessInstanceApi UpdateSuspensionStateById Put /process-instance/{id}/suspended
SchemaLogApi GetSchemaLog Get /schema/log
SchemaLogApi QuerySchemaLog Post /schema/log
SignalApi ThrowSignal Post /signal
TaskApi Claim Post /task/{id}/claim
TaskApi Complete Post /task/{id}/complete
TaskApi CreateTask Post /task/create
TaskApi DelegateTask Post /task/{id}/delegate
TaskApi DeleteTask Delete /task/{id}
TaskApi GetDeployedForm Get /task/{id}/deployed-form
TaskApi GetForm Get /task/{id}/form
TaskApi GetFormVariables Get /task/{id}/form-variables
TaskApi GetRenderedForm Get /task/{id}/rendered-form
TaskApi GetTask Get /task/{id}
TaskApi GetTasks Get /task
TaskApi GetTasksCount Get /task/count
TaskApi HandleBpmnError Post /task/{id}/bpmnError
TaskApi HandleEscalation Post /task/{id}/bpmnEscalation
TaskApi QueryTasks Post /task
TaskApi QueryTasksCount Post /task/count
TaskApi Resolve Post /task/{id}/resolve
TaskApi SetAssignee Post /task/{id}/assignee
TaskApi Submit Post /task/{id}/submit-form
TaskApi Unclaim Post /task/{id}/unclaim
TaskApi UpdateTask Put /task/{id}
TaskAttachmentApi AddAttachment Post /task/{id}/attachment/create
TaskAttachmentApi DeleteAttachment Delete /task/{id}/attachment/{attachmentId}
TaskAttachmentApi GetAttachment Get /task/{id}/attachment/{attachmentId}
TaskAttachmentApi GetAttachmentData Get /task/{id}/attachment/{attachmentId}/data
TaskAttachmentApi GetAttachments Get /task/{id}/attachment
TaskCommentApi CreateComment Post /task/{id}/comment/create
TaskCommentApi GetComment Get /task/{id}/comment/{commentId}
TaskCommentApi GetComments Get /task/{id}/comment
TaskIdentityLinkApi AddIdentityLink Post /task/{id}/identity-links
TaskIdentityLinkApi DeleteIdentityLink Post /task/{id}/identity-links/delete
TaskIdentityLinkApi GetIdentityLinks Get /task/{id}/identity-links
TaskLocalVariableApi DeleteTaskLocalVariable Delete /task/{id}/localVariables/{varName}
TaskLocalVariableApi GetTaskLocalVariable Get /task/{id}/localVariables/{varName}
TaskLocalVariableApi GetTaskLocalVariableBinary Get /task/{id}/localVariables/{varName}/data
TaskLocalVariableApi GetTaskLocalVariables Get /task/{id}/localVariables
TaskLocalVariableApi ModifyTaskLocalVariables Post /task/{id}/localVariables
TaskLocalVariableApi PutTaskLocalVariable Put /task/{id}/localVariables/{varName}
TaskLocalVariableApi SetBinaryTaskLocalVariable Post /task/{id}/localVariables/{varName}/data
TaskVariableApi DeleteTaskVariable Delete /task/{id}/variables/{varName}
TaskVariableApi GetTaskVariable Get /task/{id}/variables/{varName}
TaskVariableApi GetTaskVariableBinary Get /task/{id}/variables/{varName}/data
TaskVariableApi GetTaskVariables Get /task/{id}/variables
TaskVariableApi ModifyTaskVariables Post /task/{id}/variables
TaskVariableApi PutTaskVariable Put /task/{id}/variables/{varName}
TaskVariableApi SetBinaryTaskVariable Post /task/{id}/variables/{varName}/data
VersionApi GetRestAPIVersion Get /version

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {
	ConditionApi *ConditionApiService

	DeploymentApi *DeploymentApiService

	EngineApi *EngineApiService

	EventSubscriptionApi *EventSubscriptionApiService

	ExternalTaskApi *ExternalTaskApiService

	MessageApi *MessageApiService

	MetricsApi *MetricsApiService

	ProcessDefinitionApi *ProcessDefinitionApiService

	ProcessInstanceApi *ProcessInstanceApiService

	SchemaLogApi *SchemaLogApiService

	SignalApi *SignalApiService

	TaskApi *TaskApiService

	TaskAttachmentApi *TaskAttachmentApiService

	TaskCommentApi *TaskCommentApiService

	TaskIdentityLinkApi *TaskIdentityLinkApiService

	TaskLocalVariableApi *TaskLocalVariableApiService

	TaskVariableApi *TaskVariableApiService

	VersionApi *VersionApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Camunda BPM REST API API v7.13.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ActivityInstanceDto

type ActivityInstanceDto struct {
	// The id of the activity instance.
	Id string `json:"id,omitempty"`
	// The id of the parent activity instance, for example a sub process instance.
	ParentActivityInstanceId string `json:"parentActivityInstanceId,omitempty"`
	// The id of the activity.
	ActivityId string `json:"activityId,omitempty"`
	// The name of the activity
	ActivityName string `json:"activityName,omitempty"`
	// The type of activity (corresponds to the XML element name in the BPMN 2.0, e.g., 'userTask')
	ActivityType string `json:"activityType,omitempty"`
	// The id of the process instance this activity instance is part of.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// The id of the process definition.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// A list of child activity instances.
	ChildActivityInstances []ActivityInstanceDto `json:"childActivityInstances,omitempty"`
	// A list of child transition instances. A transition instance represents an execution waiting in an asynchronous continuation.
	ChildTransitionInstances []TransitionInstanceDto `json:"childTransitionInstances,omitempty"`
	// A list of execution ids.
	ExecutionIds []string `json:"executionIds,omitempty"`
	// A list of incident ids.
	IncidentIds []string `json:"incidentIds,omitempty"`
	// A list of JSON objects containing incident specific properties: * `id`: the id of the incident * `activityId`: the activity id in which the incident occurred
	Incidents []ActivityInstanceIncidentDto `json:"incidents,omitempty"`
}

ActivityInstanceDto A JSON object corresponding to the Activity Instance tree of the given process instance.

type ActivityInstanceIncidentDto

type ActivityInstanceIncidentDto struct {
	// The id of the incident.
	Id string `json:"id,omitempty"`
	// The activity id in which the incident happened.
	ParentActivityInstanceId string `json:"parentActivityInstanceId,omitempty"`
}

ActivityInstanceIncidentDto An activity instance, incident pair.

type ActivityStatisticsResultDto

type ActivityStatisticsResultDto struct {
	// The id of the activity the results are aggregated for.
	Id string `json:"id,omitempty"`
	// The total number of running process instances of this activity.
	Instances int32 `json:"instances,omitempty"`
	// The total number of failed jobs for the running instances. **Note**: Will be `0` (not `null`), if failed jobs were excluded.
	FailedJobs int32 `json:"failedJobs,omitempty"`
	// Each item in the resulting array is an object which contains `incidentType` and `incidentCount`. **Note**: Will be an empty array, if `incidents` or `incidentsForType` were excluded. Furthermore, the array will be also empty if no incidents were found.
	Incidents []IncidentStatisticsResultDto `json:"incidents,omitempty"`
}

ActivityStatisticsResultDto struct for ActivityStatisticsResultDto

type AddAttachmentOpts

type AddAttachmentOpts struct {
	AttachmentName        optional.String
	AttachmentDescription optional.String
	AttachmentType        optional.String
	Url                   optional.String
	Content               optional.Interface
}

AddAttachmentOpts Optional parameters for the method 'AddAttachment'

type AddIdentityLinkOpts

type AddIdentityLinkOpts struct {
	IdentityLinkDto optional.Interface
}

AddIdentityLinkOpts Optional parameters for the method 'AddIdentityLink'

type AtomLink struct {
	// The relation of the link to the object that belogs to.
	Rel string `json:"rel,omitempty"`
	// The url of the link.
	Href string `json:"href,omitempty"`
	// The http method.
	Method string `json:"method,omitempty"`
}

AtomLink struct for AtomLink

type AttachmentDto

type AttachmentDto struct {
	// The id of the task attachment.
	Id string `json:"id,omitempty"`
	// The name of the task attachment.
	Name string `json:"name,omitempty"`
	// The description of the task attachment.
	Description string `json:"description,omitempty"`
	// The id of the task to which the attachment belongs.
	TaskId string `json:"taskId,omitempty"`
	// Indication of the type of content that this attachment refers to. Can be MIME type or any other indication.
	Type string `json:"type,omitempty"`
	// The url to the remote content of the task attachment.
	Url string `json:"url,omitempty"`
	// The time the variable was inserted. [Default format](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	CreateTime string `json:"createTime,omitempty"`
	// The time after which the attachment should be removed by the History Cleanup job. [Default format](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	RemovalTime *string `json:"removalTime,omitempty"`
	// The process instance id of the root process instance that initiated the process containing the task.
	RootProcessInstanceId string `json:"rootProcessInstanceId,omitempty"`
	// The links associated to this resource, with `method`, `href` and `rel`.
	Links []AtomLink `json:"links,omitempty"`
}

AttachmentDto struct for AttachmentDto

type AttachmentDtoAllOf

type AttachmentDtoAllOf struct {
	// The id of the task attachment.
	Id string `json:"id,omitempty"`
	// The name of the task attachment.
	Name string `json:"name,omitempty"`
	// The description of the task attachment.
	Description string `json:"description,omitempty"`
	// The id of the task to which the attachment belongs.
	TaskId string `json:"taskId,omitempty"`
	// Indication of the type of content that this attachment refers to. Can be MIME type or any other indication.
	Type string `json:"type,omitempty"`
	// The url to the remote content of the task attachment.
	Url string `json:"url,omitempty"`
	// The time the variable was inserted. [Default format](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	CreateTime string `json:"createTime,omitempty"`
	// The time after which the attachment should be removed by the History Cleanup job. [Default format](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	RemovalTime *string `json:"removalTime,omitempty"`
	// The process instance id of the root process instance that initiated the process containing the task.
	RootProcessInstanceId string `json:"rootProcessInstanceId,omitempty"`
}

AttachmentDtoAllOf struct for AttachmentDtoAllOf

type AuthorizationExceptionDto

type AuthorizationExceptionDto struct {
	// The id of the user that does not have expected permissions
	UserId                string                    `json:"userId,omitempty"`
	MissingAuthorizations []MissingAuthorizationDto `json:"missingAuthorizations,omitempty"`
	// An exception class indicating the occurred error.
	Type string `json:"type,omitempty"`
	// A detailed message of the error.
	Message string `json:"message,omitempty"`
}

AuthorizationExceptionDto struct for AuthorizationExceptionDto

type AuthorizationExceptionDtoAllOf

type AuthorizationExceptionDtoAllOf struct {
	// The id of the user that does not have expected permissions
	UserId                string                    `json:"userId,omitempty"`
	MissingAuthorizations []MissingAuthorizationDto `json:"missingAuthorizations,omitempty"`
}

AuthorizationExceptionDtoAllOf struct for AuthorizationExceptionDtoAllOf

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BatchDto

type BatchDto struct {
	// The id of the batch.
	Id string `json:"id,omitempty"`
	// The type of the batch.
	Type string `json:"type,omitempty"`
	// The total jobs of a batch is the number of batch execution jobs required to complete the batch.
	TotalJobs int32 `json:"totalJobs,omitempty"`
	// The number of batch execution jobs already created by the seed job.
	JobsCreated int32 `json:"jobsCreated,omitempty"`
	// The number of batch execution jobs created per seed job invocation. The batch seed job is invoked until it has created all batch execution jobs required by the batch (see totalJobs property).
	BatchJobsPerSeed int32 `json:"batchJobsPerSeed,omitempty"`
	// Every batch execution job invokes the command executed by the batch invocationsPerBatchJob times. E.g., for a process instance migration batch this specifies the number of process instances which are migrated per batch execution job.
	InvocationsPerBatchJob int32 `json:"invocationsPerBatchJob,omitempty"`
	// The job definition id for the seed jobs of this batch.
	SeedJobDefinitionId string `json:"seedJobDefinitionId,omitempty"`
	// The job definition id for the monitor jobs of this batch.
	MonitorJobDefinitionId string `json:"monitorJobDefinitionId,omitempty"`
	// The job definition id for the batch execution jobs of this batch.
	BatchJobDefinitionId string `json:"batchJobDefinitionId,omitempty"`
	// Indicates whether this batch is suspended or not.
	Suspended bool `json:"suspended,omitempty"`
	// The tenant id of the batch.
	TenantId string `json:"tenantId,omitempty"`
	// The id of the user that created the batch.
	CreateUserId string `json:"createUserId,omitempty"`
}

BatchDto struct for BatchDto

type CaseDefinitionDto

type CaseDefinitionDto struct {
	// The id of the case definition
	Id string `json:"id,omitempty"`
	// The key of the case definition, i.e., the id of the CMMN 2.0 XML case definition.
	Key string `json:"key,omitempty"`
	// The category of the case definition.
	Category string `json:"category,omitempty"`
	// The name of the case definition.
	Name string `json:"name,omitempty"`
	// The version of the case definition that the engine assigned to it.
	Version int32 `json:"version,omitempty"`
	// The file name of the case definition.
	Resource string `json:"resource,omitempty"`
	// The deployment id of the case definition.
	DeploymentId string `json:"deploymentId,omitempty"`
	// The tenant id of the case definition.
	TenantId string `json:"tenantId,omitempty"`
	// History time to live value of the case definition. Is used within [History cleanup](https://docs.camunda.org/manual/7.13/user-guide/process-engine/history/#history-cleanup).
	HistoryTimeToLive *int32 `json:"historyTimeToLive,omitempty"`
}

CaseDefinitionDto struct for CaseDefinitionDto

type ClaimOpts

type ClaimOpts struct {
	UserIdDto optional.Interface
}

ClaimOpts Optional parameters for the method 'Claim'

type CommentDto

type CommentDto struct {
	// The id of the task comment.
	Id string `json:"id,omitempty"`
	// The id of the user who created the comment.
	UserId string `json:"userId,omitempty"`
	// The id of the task to which the comment belongs.
	TaskId string `json:"taskId,omitempty"`
	// The time when the comment was created. [Default format]($(docsUrl)/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	Time string `json:"time,omitempty"`
	// The content of the comment.
	Message string `json:"message,omitempty"`
	// The time after which the comment should be removed by the History Cleanup job. [Default format]($(docsUrl)/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	RemovalTime *string `json:"removalTime,omitempty"`
	// The process instance id of the root process instance that initiated the process containing the task.
	RootProcessInstanceId string `json:"rootProcessInstanceId,omitempty"`
	// The links associated to this resource, with `method`, `href` and `rel`.
	Links []AtomLink `json:"links,omitempty"`
}

CommentDto struct for CommentDto

type CommentDtoAllOf

type CommentDtoAllOf struct {
	// The id of the task comment.
	Id string `json:"id,omitempty"`
	// The id of the user who created the comment.
	UserId string `json:"userId,omitempty"`
	// The id of the task to which the comment belongs.
	TaskId string `json:"taskId,omitempty"`
	// The time when the comment was created. [Default format]($(docsUrl)/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	Time string `json:"time,omitempty"`
	// The content of the comment.
	Message string `json:"message,omitempty"`
	// The time after which the comment should be removed by the History Cleanup job. [Default format]($(docsUrl)/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	RemovalTime *string `json:"removalTime,omitempty"`
	// The process instance id of the root process instance that initiated the process containing the task.
	RootProcessInstanceId string `json:"rootProcessInstanceId,omitempty"`
}

CommentDtoAllOf struct for CommentDtoAllOf

type CompleteExternalTaskDto

type CompleteExternalTaskDto struct {
	// The id of the worker that completes the task. Must match the id of the worker who has most recently locked the task.
	WorkerId string `json:"workerId,omitempty"`
	// A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object with the following properties:
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
	// A JSON object containing local variable key-value pairs. Local variables are set only in the scope of external task. Each key is a variable name and each value a JSON variable value object with the following properties:
	LocalVariables map[string]VariableValueDto `json:"localVariables,omitempty"`
}

CompleteExternalTaskDto struct for CompleteExternalTaskDto

type CompleteExternalTaskResourceOpts

type CompleteExternalTaskResourceOpts struct {
	CompleteExternalTaskDto optional.Interface
}

CompleteExternalTaskResourceOpts Optional parameters for the method 'CompleteExternalTaskResource'

type CompleteOpts

type CompleteOpts struct {
	CompleteTaskDto optional.Interface
}

CompleteOpts Optional parameters for the method 'Complete'

type CompleteTaskDto

type CompleteTaskDto struct {
	// A JSON object containing variable key-value pairs.
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
	// Indicates whether the response should contain the process variables or not. The default is `false` with a response code of `204`. If set to `true` the response contains the process variables and has a response code of `200`. If the task is not associated with a process instance (e.g. if it's part of a case instance) no variables will be returned.
	WithVariablesInReturn *bool `json:"withVariablesInReturn,omitempty"`
}

CompleteTaskDto struct for CompleteTaskDto

type ConditionApiService

type ConditionApiService service

ConditionApiService ConditionApi service

func (*ConditionApiService) EvaluateCondition

func (a *ConditionApiService) EvaluateCondition(ctx _context.Context, localVarOptionals *EvaluateConditionOpts) ([]ProcessInstanceDto, *_nethttp.Response, error)

EvaluateCondition Method for EvaluateCondition Triggers evaluation of conditions for conditional start event(s). Internally this maps to the engines condition evaluation builder method ConditionEvaluationBuilder#evaluateStartConditions(). For more information see the [Conditional Start Events](https://docs.camunda.org/manual/7.13/reference/bpmn20/events/conditional-events/#conditional-start-event) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.13/reference/bpmn20/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *EvaluateConditionOpts - Optional Parameters:
  • @param "EvaluationConditionDto" (optional.Interface of EvaluationConditionDto) -

@return []ProcessInstanceDto

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

type CorrelationMessageDto

type CorrelationMessageDto struct {
	// The name of the message to deliver.
	MessageName string `json:"messageName,omitempty"`
	// Used for correlation of process instances that wait for incoming messages. Will only correlate to executions that belong to a process instance with the provided business key.
	BusinessKey string `json:"businessKey,omitempty"`
	// Used to correlate the message for a tenant with the given id. Will only correlate to executions and process definitions which belong to the tenant. Must not be supplied in conjunction with a `withoutTenantId`.
	TenantId string `json:"tenantId,omitempty"`
	// A Boolean value that indicates whether the message should only be correlated to executions and process definitions which belong to no tenant or not. Value may only be `true`, as `false` is the default behavior. Must not be supplied in conjunction with a `tenantId`.
	WithoutTenantId *bool `json:"withoutTenantId,omitempty"`
	// Used to correlate the message to the process instance with the given id.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// Used for correlation of process instances that wait for incoming messages. Has to be a JSON object containing key-value pairs that are matched against process instance variables during correlation. Each key is a variable name and each value a JSON variable value object with the following properties.
	CorrelationKeys map[string]VariableValueDto `json:"correlationKeys,omitempty"`
	// Local variables used for correlation of executions (process instances) that wait for incoming messages. Has to be a JSON object containing key-value pairs that are matched against local variables during correlation. Each key is a variable name and each value a JSON variable value object with the following properties.
	LocalCorrelationKeys map[string]VariableValueDto `json:"localCorrelationKeys,omitempty"`
	// A map of variables that is injected into the triggered execution or process instance after the message has been delivered. Each key is a variable name and each value a JSON variable value object with the following properties.
	ProcessVariables map[string]VariableValueDto `json:"processVariables,omitempty"`
	// A map of local variables that is injected into the triggered execution or process instance after the message has been delivered. Each key is a variable name and each value a JSON variable value object with the following properties.
	ProcessVariablesLocal map[string]VariableValueDto `json:"processVariablesLocal,omitempty"`
	// A Boolean value that indicates whether the message should be correlated to exactly one entity or multiple entities. If the value is set to `false`, the message will be correlated to exactly one entity (execution or process definition). If the value is set to `true`, the message will be correlated to multiple executions and a process definition that can be instantiated by this message in one go.
	All *bool `json:"all,omitempty"`
	// A Boolean value that indicates whether the result of the correlation should be returned or not. If this property is set to `true`, there will be returned a list of message correlation result objects. Depending on the all property, there will be either one ore more returned results in the list.  The default value is `false`, which means no result will be returned.
	ResultEnabled *bool `json:"resultEnabled,omitempty"`
	// A Boolean value that indicates whether the result of the correlation should contain process variables or not. The parameter resultEnabled should be set to `true` in order to use this it.  The default value is `false`, which means the variables will not be returned.
	VariablesInResultEnabled *bool `json:"variablesInResultEnabled,omitempty"`
}

CorrelationMessageDto struct for CorrelationMessageDto

type CountResultDto

type CountResultDto struct {
	// The number of matching instances.
	Count int64 `json:"count,omitempty"`
}

CountResultDto struct for CountResultDto

type CreateCommentOpts

type CreateCommentOpts struct {
	CommentDto optional.Interface
}

CreateCommentOpts Optional parameters for the method 'CreateComment'

type CreateDeploymentOpts

type CreateDeploymentOpts struct {
	TenantId                 optional.String
	DeploymentSource         optional.String
	DeployChangedOnly        optional.Bool
	EnableDuplicateFiltering optional.Bool
	DeploymentName           optional.String
	Data                     optional.Interface
}

CreateDeploymentOpts Optional parameters for the method 'CreateDeployment'

type CreateTaskOpts

type CreateTaskOpts struct {
	TaskDto optional.Interface
}

CreateTaskOpts Optional parameters for the method 'CreateTask'

type DecisionDefinitionDto

type DecisionDefinitionDto struct {
	// The id of the decision definition
	Id string `json:"id,omitempty"`
	// The key of the decision definition, i.e., the id of the DMN 1.0 XML decision definition.
	Key string `json:"key,omitempty"`
	// The category of the decision definition.
	Category string `json:"category,omitempty"`
	// The name of the decision definition.
	Name string `json:"name,omitempty"`
	// The version of the decision definition that the engine assigned to it.
	Version int32 `json:"version,omitempty"`
	// The file name of the decision definition.
	Resource string `json:"resource,omitempty"`
	// The deployment id of the decision definition.
	DeploymentId string `json:"deploymentId,omitempty"`
	// The tenant id of the decision definition.
	TenantId string `json:"tenantId,omitempty"`
	// The id of the decision requirements definition this decision definition belongs to.
	DecisionRequirementsDefinitionId string `json:"decisionRequirementsDefinitionId,omitempty"`
	// The key of the decision requirements definition this decision definition belongs to.
	DecisionRequirementsDefinitionKey string `json:"decisionRequirementsDefinitionKey,omitempty"`
	// History time to live value of the decision definition. Is used within [History cleanup](https://docs.camunda.org/manual/7.13/user-guide/process-engine/history/#history-cleanup).
	HistoryTimeToLive *int32 `json:"historyTimeToLive,omitempty"`
	// The version tag of the decision definition.
	VersionTag string `json:"versionTag,omitempty"`
}

DecisionDefinitionDto struct for DecisionDefinitionDto

type DecisionRequirementsDefinitionDto

type DecisionRequirementsDefinitionDto struct {
	// The id of the decision requirements definition
	Id string `json:"id,omitempty"`
	// The key of the decision requirements definition, i.e., the id of the DMN 1.0 XML decision definition.
	Key string `json:"key,omitempty"`
	// The name of the decision requirements definition.
	Name string `json:"name,omitempty"`
	// The category of the decision requirements definition.
	Category string `json:"category,omitempty"`
	// The version of the decision requirements definition that the engine assigned to it.
	Version int32 `json:"version,omitempty"`
	// The file name of the decision requirements definition.
	Resource string `json:"resource,omitempty"`
	// The deployment id of the decision requirements definition.
	DeploymentId string `json:"deploymentId,omitempty"`
	// The tenant id of the decisionrequirements definition.
	TenantId string `json:"tenantId,omitempty"`
}

DecisionRequirementsDefinitionDto struct for DecisionRequirementsDefinitionDto

type DelegateTaskOpts

type DelegateTaskOpts struct {
	UserIdDto optional.Interface
}

DelegateTaskOpts Optional parameters for the method 'DelegateTask'

type DeleteAsyncHistoricQueryBasedOpts

type DeleteAsyncHistoricQueryBasedOpts struct {
	DeleteProcessInstancesDto optional.Interface
}

DeleteAsyncHistoricQueryBasedOpts Optional parameters for the method 'DeleteAsyncHistoricQueryBased'

type DeleteDeploymentOpts

type DeleteDeploymentOpts struct {
	Cascade             optional.Bool
	SkipCustomListeners optional.Bool
	SkipIoMappings      optional.Bool
}

DeleteDeploymentOpts Optional parameters for the method 'DeleteDeployment'

type DeleteIdentityLinkOpts

type DeleteIdentityLinkOpts struct {
	IdentityLinkDto optional.Interface
}

DeleteIdentityLinkOpts Optional parameters for the method 'DeleteIdentityLink'

type DeleteProcessDefinitionOpts

type DeleteProcessDefinitionOpts struct {
	Cascade             optional.Bool
	SkipCustomListeners optional.Bool
	SkipIoMappings      optional.Bool
}

DeleteProcessDefinitionOpts Optional parameters for the method 'DeleteProcessDefinition'

type DeleteProcessDefinitionsByKeyAndTenantIdOpts

type DeleteProcessDefinitionsByKeyAndTenantIdOpts struct {
	Cascade             optional.Bool
	SkipCustomListeners optional.Bool
	SkipIoMappings      optional.Bool
}

DeleteProcessDefinitionsByKeyAndTenantIdOpts Optional parameters for the method 'DeleteProcessDefinitionsByKeyAndTenantId'

type DeleteProcessDefinitionsByKeyOpts

type DeleteProcessDefinitionsByKeyOpts struct {
	Cascade             optional.Bool
	SkipCustomListeners optional.Bool
	SkipIoMappings      optional.Bool
}

DeleteProcessDefinitionsByKeyOpts Optional parameters for the method 'DeleteProcessDefinitionsByKey'

type DeleteProcessInstanceOpts

type DeleteProcessInstanceOpts struct {
	SkipCustomListeners optional.Bool
	SkipIoMappings      optional.Bool
	SkipSubprocesses    optional.Bool
	FailIfNotExists     optional.Bool
}

DeleteProcessInstanceOpts Optional parameters for the method 'DeleteProcessInstance'

type DeleteProcessInstancesAsyncOperationOpts

type DeleteProcessInstancesAsyncOperationOpts struct {
	DeleteProcessInstancesDto optional.Interface
}

DeleteProcessInstancesAsyncOperationOpts Optional parameters for the method 'DeleteProcessInstancesAsyncOperation'

type DeleteProcessInstancesDto

type DeleteProcessInstancesDto struct {
	// A list process instance ids to delete.
	ProcessInstanceIds []string `json:"processInstanceIds,omitempty"`
	// A string with delete reason.
	DeleteReason string `json:"deleteReason,omitempty"`
	// Skip execution listener invocation for activities that are started or ended as part of this request.
	SkipCustomListeners *bool `json:"skipCustomListeners,omitempty"`
	// Skip deletion of the subprocesses related to deleted processes as part of this request.
	SkipSubprocesses             *bool                           `json:"skipSubprocesses,omitempty"`
	ProcessInstanceQuery         ProcessInstanceQueryDto         `json:"processInstanceQuery,omitempty"`
	HistoricProcessInstanceQuery HistoricProcessInstanceQueryDto `json:"historicProcessInstanceQuery,omitempty"`
}

DeleteProcessInstancesDto struct for DeleteProcessInstancesDto

type DeliverMessageOpts

type DeliverMessageOpts struct {
	CorrelationMessageDto optional.Interface
}

DeliverMessageOpts Optional parameters for the method 'DeliverMessage'

type DeploymentApiService

type DeploymentApiService service

DeploymentApiService DeploymentApi service

func (*DeploymentApiService) CreateDeployment

CreateDeployment Method for CreateDeployment Creates a deployment. **Security Consideration** Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateDeploymentOpts - Optional Parameters:
  • @param "TenantId" (optional.String) - The tenant id for the deployment to be created.
  • @param "DeploymentSource" (optional.String) - The source for the deployment to be created.
  • @param "DeployChangedOnly" (optional.Bool) - A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true.
  • @param "EnableDuplicateFiltering" (optional.Bool) - A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false.
  • @param "DeploymentName" (optional.String) - The name for the deployment to be created.
  • @param "Data" (optional.Interface of *os.File) - The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment.

@return DeploymentWithDefinitionsDto

func (*DeploymentApiService) DeleteDeployment

func (a *DeploymentApiService) DeleteDeployment(ctx _context.Context, id string, localVarOptionals *DeleteDeploymentOpts) (*_nethttp.Response, error)

DeleteDeployment Method for DeleteDeployment Deletes a deployment by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the deployment to be deleted.
  • @param optional nil or *DeleteDeploymentOpts - Optional Parameters:
  • @param "Cascade" (optional.Bool) - `true`, if all process instances, historic process instances and jobs for this deployment should be deleted.
  • @param "SkipCustomListeners" (optional.Bool) - `true`, if only the built-in ExecutionListeners should be notified with the end event.
  • @param "SkipIoMappings" (optional.Bool) - `true`, if all input/output mappings should not be invoked.

func (*DeploymentApiService) GetDeployment

GetDeployment Method for GetDeployment Retrieves a deployment by id, according to the `Deployment` interface of the engine.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the deployment.

@return []DeploymentDto

func (*DeploymentApiService) GetDeploymentResource

func (a *DeploymentApiService) GetDeploymentResource(ctx _context.Context, id string, resourceId string) (DeploymentResourceDto, *_nethttp.Response, error)

GetDeploymentResource Method for GetDeploymentResource Retrieves a deployment resource by resource id for the given deployment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the deployment
  • @param resourceId The id of the deployment resource

@return DeploymentResourceDto

func (*DeploymentApiService) GetDeploymentResourceData

func (a *DeploymentApiService) GetDeploymentResourceData(ctx _context.Context, id string, resourceId string) (*os.File, *_nethttp.Response, error)

GetDeploymentResourceData Method for GetDeploymentResourceData Retrieves the binary content of a deployment resource for the given deployment by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the deployment.
  • @param resourceId The id of the deployment resource.

@return *os.File

func (*DeploymentApiService) GetDeploymentResources

func (a *DeploymentApiService) GetDeploymentResources(ctx _context.Context, id string) ([]DeploymentResourceDto, *_nethttp.Response, error)

GetDeploymentResources Method for GetDeploymentResources Retrieves all deployment resources of a given deployment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the deployment to retrieve the deployment resources for.

@return []DeploymentResourceDto

func (*DeploymentApiService) GetDeployments

func (a *DeploymentApiService) GetDeployments(ctx _context.Context, localVarOptionals *GetDeploymentsOpts) ([]DeploymentDto, *_nethttp.Response, error)

GetDeployments Method for GetDeployments Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the [Get Deployment count](https://docs.camunda.org/manual/7.13/reference/rest/deployment/get-query-count/) method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetDeploymentsOpts - Optional Parameters:
  • @param "Id" (optional.String) - Filter by deployment id
  • @param "Name" (optional.String) - Filter by the deployment name. Exact match.
  • @param "NameLike" (optional.String) - Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`).
  • @param "Source" (optional.String) - Filter by the deployment source.
  • @param "WithoutSource" (optional.Bool) - Filter by the deployment source whereby source is equal to `null`.
  • @param "TenantIdIn" (optional.String) - Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids.
  • @param "WithoutTenantId" (optional.Bool) - Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior.
  • @param "IncludeDeploymentsWithoutTenantId" (optional.Bool) - Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior.
  • @param "After" (optional.String) - Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "Before" (optional.String) - Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "SortBy" (optional.String) - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
  • @param "SortOrder" (optional.String) - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

@return []DeploymentDto

func (*DeploymentApiService) GetDeploymentsCount

func (a *DeploymentApiService) GetDeploymentsCount(ctx _context.Context, localVarOptionals *GetDeploymentsCountOpts) (CountResultDto, *_nethttp.Response, error)

GetDeploymentsCount Method for GetDeploymentsCount Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Deployments](https://docs.camunda.org/manual/7.13/reference/rest/deployment/get-query/) method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetDeploymentsCountOpts - Optional Parameters:
  • @param "Id" (optional.String) - Filter by deployment id
  • @param "Name" (optional.String) - Filter by the deployment name. Exact match.
  • @param "NameLike" (optional.String) - Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`).
  • @param "Source" (optional.String) - Filter by the deployment source.
  • @param "WithoutSource" (optional.Bool) - Filter by the deployment source whereby source is equal to `null`.
  • @param "TenantIdIn" (optional.String) - Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids.
  • @param "WithoutTenantId" (optional.Bool) - Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior.
  • @param "IncludeDeploymentsWithoutTenantId" (optional.Bool) - Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior.
  • @param "After" (optional.String) - Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "Before" (optional.String) - Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.

@return CountResultDto

func (*DeploymentApiService) Redeploy

Redeploy Method for Redeploy Re-deploys an existing deployment. The deployment resources to re-deploy can be restricted by using the properties `resourceIds` or `resourceNames`. If no deployment resources to re-deploy are passed then all existing resources of the given deployment are re-deployed. **Warning**: Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code. See the section on [security considerations for custom code](https://docs.camunda.org/manual/7.13/user-guide/process-engine/securing-custom-code/) in the user guide for details.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the deployment to re-deploy.
  • @param optional nil or *RedeployOpts - Optional Parameters:
  • @param "RedeploymentDto" (optional.Interface of RedeploymentDto) -

@return DeploymentWithDefinitionsDto

type DeploymentDto

type DeploymentDto struct {
	// The id of the deployment.
	Id string `json:"id,omitempty"`
	// The tenant id of the deployment.
	TenantId string `json:"tenantId,omitempty"`
	// The time when the deployment was created.
	DeploymentTime string `json:"deploymentTime,omitempty"`
	// The source of the deployment.
	Source string `json:"source,omitempty"`
	// The name of the deployment.
	Name string `json:"name,omitempty"`
	// The links associated to this resource, with `method`, `href` and `rel`.
	Links []AtomLink `json:"links,omitempty"`
}

DeploymentDto struct for DeploymentDto

type DeploymentDtoAllOf

type DeploymentDtoAllOf struct {
	// The id of the deployment.
	Id string `json:"id,omitempty"`
	// The tenant id of the deployment.
	TenantId string `json:"tenantId,omitempty"`
	// The time when the deployment was created.
	DeploymentTime string `json:"deploymentTime,omitempty"`
	// The source of the deployment.
	Source string `json:"source,omitempty"`
	// The name of the deployment.
	Name string `json:"name,omitempty"`
}

DeploymentDtoAllOf struct for DeploymentDtoAllOf

type DeploymentResourceDto

type DeploymentResourceDto struct {
	// The id of the deployment resource.
	Id string `json:"id,omitempty"`
	// The name of the deployment resource
	Name string `json:"name,omitempty"`
	// The id of the deployment.
	DeploymentId string `json:"deploymentId,omitempty"`
}

DeploymentResourceDto A JSON object corresponding to the `Resource` interface in the engine. Its properties are as follows:

type DeploymentWithDefinitionsDto

type DeploymentWithDefinitionsDto struct {
	// A JSON Object containing a property for each of the process definitions, which are successfully deployed with that deployment. The key is the process definition id, the value is a JSON Object corresponding to the process definition.
	DeployedProcessDefinitions map[string]ProcessDefinitionDto `json:"deployedProcessDefinitions,omitempty"`
	// A JSON Object containing a property for each of the decision definitions, which are successfully deployed with that deployment. The key is the decision definition id, the value is a JSON Object corresponding to the decision definition.
	DeployedDecisionDefinitions map[string]DecisionDefinitionDto `json:"deployedDecisionDefinitions,omitempty"`
	// A JSON Object containing a property for each of the decision requirements definitions, which are successfully deployed with that deployment. The key is the decision requirements definition id, the value is a JSON Object corresponding to the decision requirements definition.
	DeployedDecisionRequirementsDefinitions map[string]DecisionRequirementsDefinitionDto `json:"deployedDecisionRequirementsDefinitions,omitempty"`
	// A JSON Object containing a property for each of the case definitions, which are successfully deployed with that deployment. The key is the case definition id, the value is a JSON Object corresponding to the case definition.
	DeployedCaseDefinitions map[string]CaseDefinitionDto `json:"deployedCaseDefinitions,omitempty"`
	// The id of the deployment.
	Id string `json:"id,omitempty"`
	// The tenant id of the deployment.
	TenantId string `json:"tenantId,omitempty"`
	// The time when the deployment was created.
	DeploymentTime string `json:"deploymentTime,omitempty"`
	// The source of the deployment.
	Source string `json:"source,omitempty"`
	// The name of the deployment.
	Name string `json:"name,omitempty"`
	// The links associated to this resource, with `method`, `href` and `rel`.
	Links []AtomLink `json:"links,omitempty"`
}

DeploymentWithDefinitionsDto struct for DeploymentWithDefinitionsDto

type DeploymentWithDefinitionsDtoAllOf

type DeploymentWithDefinitionsDtoAllOf struct {
	// A JSON Object containing a property for each of the process definitions, which are successfully deployed with that deployment. The key is the process definition id, the value is a JSON Object corresponding to the process definition.
	DeployedProcessDefinitions map[string]ProcessDefinitionDto `json:"deployedProcessDefinitions,omitempty"`
	// A JSON Object containing a property for each of the decision definitions, which are successfully deployed with that deployment. The key is the decision definition id, the value is a JSON Object corresponding to the decision definition.
	DeployedDecisionDefinitions map[string]DecisionDefinitionDto `json:"deployedDecisionDefinitions,omitempty"`
	// A JSON Object containing a property for each of the decision requirements definitions, which are successfully deployed with that deployment. The key is the decision requirements definition id, the value is a JSON Object corresponding to the decision requirements definition.
	DeployedDecisionRequirementsDefinitions map[string]DecisionRequirementsDefinitionDto `json:"deployedDecisionRequirementsDefinitions,omitempty"`
	// A JSON Object containing a property for each of the case definitions, which are successfully deployed with that deployment. The key is the case definition id, the value is a JSON Object corresponding to the case definition.
	DeployedCaseDefinitions map[string]CaseDefinitionDto `json:"deployedCaseDefinitions,omitempty"`
}

DeploymentWithDefinitionsDtoAllOf struct for DeploymentWithDefinitionsDtoAllOf

type EngineApiService

type EngineApiService service

EngineApiService EngineApi service

func (*EngineApiService) GetProcessEngineNames

func (a *EngineApiService) GetProcessEngineNames(ctx _context.Context) ([]ProcessEngineDto, *_nethttp.Response, error)

GetProcessEngineNames Method for GetProcessEngineNames Retrieves the names of all process engines available on your platform. **Note**: You cannot prepend `/engine/{name}` to this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []ProcessEngineDto

type EvaluateConditionOpts

type EvaluateConditionOpts struct {
	EvaluationConditionDto optional.Interface
}

EvaluateConditionOpts Optional parameters for the method 'EvaluateCondition'

type EvaluationConditionDto

type EvaluationConditionDto struct {
	// A map of variables which are used for evaluation of the conditions and are injected into the process instances which have been triggered. Each key is a variable name and each value a JSON variable value object with the following properties.
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
	// Used for the process instances that have been triggered after the evaluation.
	BusinessKey string `json:"businessKey,omitempty"`
	// Used to evaluate a condition for a tenant with the given id. Will only evaluate conditions of process definitions which belong to the tenant.
	TenantId string `json:"tenantId,omitempty"`
	// A Boolean value that indicates whether the conditions should only be evaluated of process definitions which belong to no tenant or not. Value may only be true, as false is the default behavior.
	WithoutTenantId *bool `json:"withoutTenantId,omitempty"`
	// Used to evaluate conditions of the process definition with the given id.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
}

EvaluationConditionDto struct for EvaluationConditionDto

type EventSubscriptionApiService

type EventSubscriptionApiService service

EventSubscriptionApiService EventSubscriptionApi service

func (*EventSubscriptionApiService) GetEventSubscriptions

func (a *EventSubscriptionApiService) GetEventSubscriptions(ctx _context.Context, localVarOptionals *GetEventSubscriptionsOpts) ([]EventSubscriptionDto, *_nethttp.Response, error)

GetEventSubscriptions Method for GetEventSubscriptions Queries for event subscriptions that fulfill given parameters. The size of the result set can be retrieved by using the [Get Event Subscriptions count](https://docs.camunda.org/manual/7.13/reference/rest/event-subscription/get-query-count/) method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEventSubscriptionsOpts - Optional Parameters:
  • @param "EventSubscriptionId" (optional.String) - Only select subscription with the given id.
  • @param "EventName" (optional.String) - Only select subscriptions for events with the given name.
  • @param "EventType" (optional.String) - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`.
  • @param "ExecutionId" (optional.String) - Only select subscriptions that belong to an execution with the given id.
  • @param "ProcessInstanceId" (optional.String) - Only select subscriptions that belong to a process instance with the given id.
  • @param "ActivityId" (optional.String) - Only select subscriptions that belong to an activity with the given id.
  • @param "TenantIdIn" (optional.String) - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids.
  • @param "WithoutTenantId" (optional.Bool) - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior.
  • @param "IncludeEventSubscriptionsWithoutTenantId" (optional.Bool) - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior.
  • @param "SortBy" (optional.String) - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
  • @param "SortOrder" (optional.String) - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

@return []EventSubscriptionDto

func (*EventSubscriptionApiService) GetEventSubscriptionsCount

func (a *EventSubscriptionApiService) GetEventSubscriptionsCount(ctx _context.Context, localVarOptionals *GetEventSubscriptionsCountOpts) (CountResultDto, *_nethttp.Response, error)

GetEventSubscriptionsCount Method for GetEventSubscriptionsCount Queries for the number of event subscriptions that fulfill given parameters. Takes the same parameters as the [Get Event Subscriptions](https://docs.camunda.org/manual/7.13/reference/rest/event-subscription/get-query/) method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEventSubscriptionsCountOpts - Optional Parameters:
  • @param "EventSubscriptionId" (optional.String) - Only select subscription with the given id.
  • @param "EventName" (optional.String) - Only select subscriptions for events with the given name.
  • @param "EventType" (optional.String) - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`.
  • @param "ExecutionId" (optional.String) - Only select subscriptions that belong to an execution with the given id.
  • @param "ProcessInstanceId" (optional.String) - Only select subscriptions that belong to a process instance with the given id.
  • @param "ActivityId" (optional.String) - Only select subscriptions that belong to an activity with the given id.
  • @param "TenantIdIn" (optional.String) - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids.
  • @param "WithoutTenantId" (optional.Bool) - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior.
  • @param "IncludeEventSubscriptionsWithoutTenantId" (optional.Bool) - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior.

@return CountResultDto

type EventSubscriptionDto

type EventSubscriptionDto struct {
	// The id of the event subscription.
	Id string `json:"id,omitempty"`
	// The type of the event subscription.
	EventType string `json:"eventType,omitempty"`
	// The name of the event this subscription belongs to as defined in the process model.
	EventName string `json:"eventName,omitempty"`
	// The execution that is subscribed on the referenced event.
	ExecutionId string `json:"executionId,omitempty"`
	// The process instance this subscription belongs to.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// The identifier of the activity that this event subscription belongs to. This could for example be the id of a receive task.
	ActivityId string `json:"activityId,omitempty"`
	// The time this event subscription was created.
	CreatedDate *string `json:"createdDate,omitempty"`
	// The id of the tenant this event subscription belongs to. Can be `null` if the subscription belongs to no single tenant.
	TenantId string `json:"tenantId,omitempty"`
}

EventSubscriptionDto struct for EventSubscriptionDto

type EventSubscriptionQueryDto

type EventSubscriptionQueryDto struct {
	// The id of the event subscription.
	EventSubscriptionId string `json:"eventSubscriptionId,omitempty"`
	// The name of the event this subscription belongs to as defined in the process model.
	EventName string `json:"eventName,omitempty"`
	// The type of the event subscription.
	EventType string `json:"eventType,omitempty"`
	// The execution that is subscribed on the referenced event.
	ExecutionId string `json:"executionId,omitempty"`
	// The process instance this subscription belongs to.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// The identifier of the activity that this event subscription belongs to. This could for example be the id of a receive task.
	ActivityId string `json:"activityId,omitempty"`
	// Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids.
	TenantIdIn []string `json:"tenantIdIn,omitempty"`
	// Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior.
	WithoutTenantId *bool `json:"withoutTenantId,omitempty"`
	// Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior.
	IncludeEventSubscriptionsWithoutTenantId *bool `json:"includeEventSubscriptionsWithoutTenantId,omitempty"`
	// Apply sorting of the result
	Sorting []EventSubscriptionQueryDtoSorting `json:"sorting,omitempty"`
}

EventSubscriptionQueryDto A event subscription query which retrieves a list of event subscriptions

type EventSubscriptionQueryDtoSorting

type EventSubscriptionQueryDtoSorting struct {
	// Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
	SortBy string `json:"sortBy,omitempty"`
	// Sort the results in a given order. Values may be `asc` for ascending order or `desc` for descending order. Must be used in conjunction with the sortBy parameter.
	SortOrder string `json:"sortOrder,omitempty"`
}

EventSubscriptionQueryDtoSorting struct for EventSubscriptionQueryDtoSorting

type ExceptionDto

type ExceptionDto struct {
	// An exception class indicating the occurred error.
	Type string `json:"type,omitempty"`
	// A detailed message of the error.
	Message string `json:"message,omitempty"`
}

ExceptionDto struct for ExceptionDto

type ExecutionDto

type ExecutionDto struct {
	// The id of the Execution.
	Id string `json:"id,omitempty"`
	// The id of the root of the execution tree representing the process instance.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// Indicates if the execution is ended.
	Ended bool `json:"ended,omitempty"`
	// The id of the tenant this execution belongs to. Can be `null` if the execution belongs to no single tenant.
	TenantId string `json:"tenantId,omitempty"`
}

ExecutionDto struct for ExecutionDto

type ExtendLockOnExternalTaskDto

type ExtendLockOnExternalTaskDto struct {
	// The ID of a worker who is locking the external task.
	WorkerId string `json:"workerId,omitempty"`
	// An amount of time (in milliseconds). This is the new lock duration starting from the current moment.
	NewDuration int64 `json:"newDuration,omitempty"`
}

ExtendLockOnExternalTaskDto struct for ExtendLockOnExternalTaskDto

type ExtendLockOpts

type ExtendLockOpts struct {
	ExtendLockOnExternalTaskDto optional.Interface
}

ExtendLockOpts Optional parameters for the method 'ExtendLock'

type ExternalTaskApiService

type ExternalTaskApiService service

ExternalTaskApiService ExternalTaskApi service

func (*ExternalTaskApiService) CompleteExternalTaskResource

func (a *ExternalTaskApiService) CompleteExternalTaskResource(ctx _context.Context, id string, localVarOptionals *CompleteExternalTaskResourceOpts) (*_nethttp.Response, error)

CompleteExternalTaskResource Method for CompleteExternalTaskResource Completes an external task by id and updates process variables.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to complete.
  • @param optional nil or *CompleteExternalTaskResourceOpts - Optional Parameters:
  • @param "CompleteExternalTaskDto" (optional.Interface of CompleteExternalTaskDto) -

func (*ExternalTaskApiService) ExtendLock

func (a *ExternalTaskApiService) ExtendLock(ctx _context.Context, id string, localVarOptionals *ExtendLockOpts) (*_nethttp.Response, error)

ExtendLock Method for ExtendLock Extends the timeout of the lock by a given amount of time.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the external task.
  • @param optional nil or *ExtendLockOpts - Optional Parameters:
  • @param "ExtendLockOnExternalTaskDto" (optional.Interface of ExtendLockOnExternalTaskDto) -

func (*ExternalTaskApiService) FetchAndLock

func (a *ExternalTaskApiService) FetchAndLock(ctx _context.Context, localVarOptionals *FetchAndLockOpts) ([]LockedExternalTaskDto, *_nethttp.Response, error)

FetchAndLock Method for FetchAndLock Fetches and locks a specific number of external tasks for execution by a worker. Query can be restricted to specific task topics and for each task topic an individual lock time can be provided.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *FetchAndLockOpts - Optional Parameters:
  • @param "FetchExternalTasksDto" (optional.Interface of FetchExternalTasksDto) -

@return []LockedExternalTaskDto

func (*ExternalTaskApiService) GetExternalTask

GetExternalTask Method for GetExternalTask Retrieves an external task by id, corresponding to the `ExternalTask` interface in the engine.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the external task to be retrieved.

@return ExternalTaskDto

func (*ExternalTaskApiService) GetExternalTaskErrorDetails

func (a *ExternalTaskApiService) GetExternalTaskErrorDetails(ctx _context.Context, id string) (string, *_nethttp.Response, error)

GetExternalTaskErrorDetails Method for GetExternalTaskErrorDetails Retrieves the error details in the context of a running external task by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the external task for which the error details should be retrieved.

@return string

func (*ExternalTaskApiService) GetExternalTasks

func (a *ExternalTaskApiService) GetExternalTasks(ctx _context.Context, localVarOptionals *GetExternalTasksOpts) ([]ExternalTaskDto, *_nethttp.Response, error)

GetExternalTasks Method for GetExternalTasks Queries for the external tasks that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of executions. The size of the result set can be retrieved by using the [Get External Task Count](https://docs.camunda.org/manual/7.13/reference/rest/external-task/get-query-count/) method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetExternalTasksOpts - Optional Parameters:
  • @param "ExternalTaskId" (optional.String) - Filter by an external task's id.
  • @param "ExternalTaskIdIn" (optional.String) - Filter by the comma-separated list of external task ids.
  • @param "TopicName" (optional.String) - Filter by an external task topic.
  • @param "WorkerId" (optional.String) - Filter by the id of the worker that the task was most recently locked by.
  • @param "Locked" (optional.Bool) - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task.
  • @param "NotLocked" (optional.Bool) - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task.
  • @param "WithRetriesLeft" (optional.Bool) - Only include external tasks that have a positive (> 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task.
  • @param "NoRetriesLeft" (optional.Bool) - Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task.
  • @param "LockExpirationAfter" (optional.String) - Restrict to external tasks that have a lock that expires after a given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "LockExpirationBefore" (optional.String) - Restrict to external tasks that have a lock that expires before a given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "ActivityId" (optional.String) - Filter by the id of the activity that an external task is created for.
  • @param "ActivityIdIn" (optional.String) - Filter by the comma-separated list of ids of the activities that an external task is created for.
  • @param "ExecutionId" (optional.String) - Filter by the id of the execution that an external task belongs to.
  • @param "ProcessInstanceId" (optional.String) - Filter by the id of the process instance that an external task belongs to.
  • @param "ProcessInstanceIdIn" (optional.String) - Filter by a comma-separated list of process instance ids that an external task may belong to.
  • @param "ProcessDefinitionId" (optional.String) - Filter by the id of the process definition that an external task belongs to.
  • @param "TenantIdIn" (optional.String) - Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids.
  • @param "Active" (optional.Bool) - Only include active tasks. Value may only be `true`, as `false` matches any external task.
  • @param "Suspended" (optional.Bool) - Only include suspended tasks. Value may only be `true`, as `false` matches any external task.
  • @param "PriorityHigherThanOrEquals" (optional.Int64) - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value.
  • @param "PriorityLowerThanOrEquals" (optional.Int64) - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value.
  • @param "SortBy" (optional.String) - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
  • @param "SortOrder" (optional.String) - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

@return []ExternalTaskDto

func (*ExternalTaskApiService) GetExternalTasksCount

func (a *ExternalTaskApiService) GetExternalTasksCount(ctx _context.Context, localVarOptionals *GetExternalTasksCountOpts) (CountResultDto, *_nethttp.Response, error)

GetExternalTasksCount Method for GetExternalTasksCount Queries for the number of external tasks that fulfill given parameters. Takes the same parameters as the [Get External Tasks](https://docs.camunda.org/manual/7.13/reference/rest/external-task/get-query/) method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetExternalTasksCountOpts - Optional Parameters:
  • @param "ExternalTaskId" (optional.String) - Filter by an external task's id.
  • @param "ExternalTaskIdIn" (optional.String) - Filter by the comma-separated list of external task ids.
  • @param "TopicName" (optional.String) - Filter by an external task topic.
  • @param "WorkerId" (optional.String) - Filter by the id of the worker that the task was most recently locked by.
  • @param "Locked" (optional.Bool) - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task.
  • @param "NotLocked" (optional.Bool) - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task.
  • @param "WithRetriesLeft" (optional.Bool) - Only include external tasks that have a positive (> 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task.
  • @param "NoRetriesLeft" (optional.Bool) - Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task.
  • @param "LockExpirationAfter" (optional.String) - Restrict to external tasks that have a lock that expires after a given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "LockExpirationBefore" (optional.String) - Restrict to external tasks that have a lock that expires before a given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "ActivityId" (optional.String) - Filter by the id of the activity that an external task is created for.
  • @param "ActivityIdIn" (optional.String) - Filter by the comma-separated list of ids of the activities that an external task is created for.
  • @param "ExecutionId" (optional.String) - Filter by the id of the execution that an external task belongs to.
  • @param "ProcessInstanceId" (optional.String) - Filter by the id of the process instance that an external task belongs to.
  • @param "ProcessInstanceIdIn" (optional.String) - Filter by a comma-separated list of process instance ids that an external task may belong to.
  • @param "ProcessDefinitionId" (optional.String) - Filter by the id of the process definition that an external task belongs to.
  • @param "TenantIdIn" (optional.String) - Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids.
  • @param "Active" (optional.Bool) - Only include active tasks. Value may only be `true`, as `false` matches any external task.
  • @param "Suspended" (optional.Bool) - Only include suspended tasks. Value may only be `true`, as `false` matches any external task.
  • @param "PriorityHigherThanOrEquals" (optional.Int64) - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value.
  • @param "PriorityLowerThanOrEquals" (optional.Int64) - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value.

@return CountResultDto

func (*ExternalTaskApiService) GetTopicNames

func (a *ExternalTaskApiService) GetTopicNames(ctx _context.Context, localVarOptionals *GetTopicNamesOpts) ([]string, *_nethttp.Response, error)

GetTopicNames Method for GetTopicNames Queries for distinct topic names of external tasks that fulfill given parameters. Query can be restricted to only tasks with retries left, tasks that are locked, or tasks that are unlocked. The parameters withLockedTasks and withUnlockedTasks are exclusive. Setting them both to true will return an empty list. Providing no parameters will return a list of all distinct topic names with external tasks.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetTopicNamesOpts - Optional Parameters:
  • @param "WithLockedTasks" (optional.Bool) - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task.
  • @param "WithUnlockedTasks" (optional.Bool) - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task.
  • @param "WithRetriesLeft" (optional.Bool) - Only include external tasks that have a positive (> 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task.

@return []string

func (*ExternalTaskApiService) HandleExternalTaskBpmnError

func (a *ExternalTaskApiService) HandleExternalTaskBpmnError(ctx _context.Context, id string, localVarOptionals *HandleExternalTaskBpmnErrorOpts) (*_nethttp.Response, error)

HandleExternalTaskBpmnError Method for HandleExternalTaskBpmnError Reports a business error in the context of a running external task by id. The error code must be specified to identify the BPMN error handler.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the external task in which context a BPMN error is reported.
  • @param optional nil or *HandleExternalTaskBpmnErrorOpts - Optional Parameters:
  • @param "ExternalTaskBpmnError" (optional.Interface of ExternalTaskBpmnError) -

func (*ExternalTaskApiService) HandleFailure

func (a *ExternalTaskApiService) HandleFailure(ctx _context.Context, id string, localVarOptionals *HandleFailureOpts) (*_nethttp.Response, error)

HandleFailure Method for HandleFailure Reports a failure to execute an external task by id. A number of retries and a timeout until the task can be retried can be specified. If retries are set to 0, an incident for this task is created.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the external task to report a failure for.
  • @param optional nil or *HandleFailureOpts - Optional Parameters:
  • @param "ExternalTaskFailureDto" (optional.Interface of ExternalTaskFailureDto) -

func (*ExternalTaskApiService) QueryExternalTasks

func (a *ExternalTaskApiService) QueryExternalTasks(ctx _context.Context, localVarOptionals *QueryExternalTasksOpts) ([]ExternalTaskDto, *_nethttp.Response, error)

QueryExternalTasks Method for QueryExternalTasks Queries for external tasks that fulfill given parameters in the form of a JSON object. This method is slightly more powerful than the [Get External Tasks](https://docs.camunda.org/manual/7.13/reference/rest/external-task/get-query/) method because it allows to specify a hierarchical result sorting.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *QueryExternalTasksOpts - Optional Parameters:
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
  • @param "ExternalTaskQueryDto" (optional.Interface of ExternalTaskQueryDto) -

@return []ExternalTaskDto

func (*ExternalTaskApiService) QueryExternalTasksCount

func (a *ExternalTaskApiService) QueryExternalTasksCount(ctx _context.Context, localVarOptionals *QueryExternalTasksCountOpts) (CountResultDto, *_nethttp.Response, error)

QueryExternalTasksCount Method for QueryExternalTasksCount Queries for the number of external tasks that fulfill given parameters. This method takes the same message body as the [Get External Tasks (POST)](https://docs.camunda.org/manual/7.13/reference/rest/external-task/post-query/) method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *QueryExternalTasksCountOpts - Optional Parameters:
  • @param "ExternalTaskQueryDto" (optional.Interface of ExternalTaskQueryDto) -

@return CountResultDto

func (*ExternalTaskApiService) SetExternalTaskResourcePriority

func (a *ExternalTaskApiService) SetExternalTaskResourcePriority(ctx _context.Context, id string, localVarOptionals *SetExternalTaskResourcePriorityOpts) (*_nethttp.Response, error)

SetExternalTaskResourcePriority Method for SetExternalTaskResourcePriority Sets the priority of an existing external task by id. The default value of a priority is 0.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the external task to set the priority for.
  • @param optional nil or *SetExternalTaskResourcePriorityOpts - Optional Parameters:
  • @param "PriorityDto" (optional.Interface of PriorityDto) -

func (*ExternalTaskApiService) SetExternalTaskResourceRetries

func (a *ExternalTaskApiService) SetExternalTaskResourceRetries(ctx _context.Context, id string, localVarOptionals *SetExternalTaskResourceRetriesOpts) (*_nethttp.Response, error)

SetExternalTaskResourceRetries Method for SetExternalTaskResourceRetries Sets the number of retries left to execute an external task by id. If retries are set to 0, an incident is created.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the external task to set the number of retries for.
  • @param optional nil or *SetExternalTaskResourceRetriesOpts - Optional Parameters:
  • @param "RetriesDto" (optional.Interface of RetriesDto) -

func (*ExternalTaskApiService) SetExternalTaskRetries

func (a *ExternalTaskApiService) SetExternalTaskRetries(ctx _context.Context, localVarOptionals *SetExternalTaskRetriesOpts) (*_nethttp.Response, error)

SetExternalTaskRetries Method for SetExternalTaskRetries Sets the number of retries left to execute external tasks by id synchronously. If retries are set to 0, an incident is created.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SetExternalTaskRetriesOpts - Optional Parameters:
  • @param "SetRetriesForExternalTasksDto" (optional.Interface of SetRetriesForExternalTasksDto) -

func (*ExternalTaskApiService) SetExternalTaskRetriesAsyncOperation

func (a *ExternalTaskApiService) SetExternalTaskRetriesAsyncOperation(ctx _context.Context, localVarOptionals *SetExternalTaskRetriesAsyncOperationOpts) (BatchDto, *_nethttp.Response, error)

SetExternalTaskRetriesAsyncOperation Method for SetExternalTaskRetriesAsyncOperation Sets the number of retries left to execute external tasks by id asynchronously. If retries are set to 0, an incident is created.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SetExternalTaskRetriesAsyncOperationOpts - Optional Parameters:
  • @param "SetRetriesForExternalTasksDto" (optional.Interface of SetRetriesForExternalTasksDto) -

@return BatchDto

func (*ExternalTaskApiService) Unlock

Unlock Method for Unlock Unlocks an external task by id. Clears the task's lock expiration time and worker id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the external task to unlock.

type ExternalTaskBpmnError

type ExternalTaskBpmnError struct {
	// The id of the worker that reports the failure. Must match the id of the worker who has most recently locked the task.
	WorkerId string `json:"workerId,omitempty"`
	// An error code that indicates the predefined error. It is used to identify the BPMN error handler.
	ErrorCode string `json:"errorCode,omitempty"`
	// An error message that describes the error.
	ErrorMessage string `json:"errorMessage,omitempty"`
	// A JSON object containing variable key-value pairs.
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
}

ExternalTaskBpmnError struct for ExternalTaskBpmnError

type ExternalTaskBpmnErrorAllOf

type ExternalTaskBpmnErrorAllOf struct {
	// The id of the worker that reports the failure. Must match the id of the worker who has most recently locked the task.
	WorkerId string `json:"workerId,omitempty"`
}

ExternalTaskBpmnErrorAllOf struct for ExternalTaskBpmnErrorAllOf

type ExternalTaskDto

type ExternalTaskDto struct {
	// The id of the activity that this external task belongs to.
	ActivityId string `json:"activityId,omitempty"`
	// The id of the activity instance that the external task belongs to.
	ActivityInstanceId string `json:"activityInstanceId,omitempty"`
	// The full error message submitted with the latest reported failure executing this task; `null` if no failure was reported previously or if no error message was submitted
	ErrorMessage string `json:"errorMessage,omitempty"`
	// The id of the execution that the external task belongs to.
	ExecutionId string `json:"executionId,omitempty"`
	// The id of the external task.
	Id string `json:"id,omitempty"`
	// The date that the task's most recent lock expires or has expired.
	LockExpirationTime *string `json:"lockExpirationTime,omitempty"`
	// The id of the process definition the external task is defined in.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// The key of the process definition the external task is defined in.
	ProcessDefinitionKey string `json:"processDefinitionKey,omitempty"`
	// The version tag of the process definition the external task is defined in.
	ProcessDefinitionVersionTag string `json:"processDefinitionVersionTag,omitempty"`
	// The id of the process instance the external task belongs to.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// The id of the tenant the external task belongs to.
	TenantId string `json:"tenantId,omitempty"`
	// The number of retries the task currently has left.
	Retries *int32 `json:"retries,omitempty"`
	// A flag indicating whether the external task is suspended or not.
	Suspended *bool `json:"suspended,omitempty"`
	// The id of the worker that posesses or posessed the most recent lock.
	WorkerId string `json:"workerId,omitempty"`
	// The topic name of the external task.
	TopicName string `json:"topicName,omitempty"`
	// The priority of the external task.
	Priority *int64 `json:"priority,omitempty"`
	// The business key of the process instance the external task belongs to.
	BusinessKey string `json:"businessKey,omitempty"`
}

ExternalTaskDto An External Task object with the following properties

type ExternalTaskFailureDto

type ExternalTaskFailureDto struct {
	// The id of the worker that reports the failure. Must match the id of the worker who has most recently locked the task.
	WorkerId string `json:"workerId,omitempty"`
	// An message indicating the reason of the failure.
	ErrorMessage string `json:"errorMessage,omitempty"`
	// A detailed error description.
	ErrorDetails string `json:"errorDetails,omitempty"`
	// A number of how often the task should be retried. Must be >= 0. If this is 0, an incident is created and the task cannot be fetched anymore unless the retries are increased again. The incident's message is set to the `errorMessage` parameter.
	Retries int32 `json:"retries,omitempty"`
	// A timeout in milliseconds before the external task becomes available again for fetching. Must be >= 0.
	RetryTimeout int64 `json:"retryTimeout,omitempty"`
}

ExternalTaskFailureDto struct for ExternalTaskFailureDto

type ExternalTaskQueryDto

type ExternalTaskQueryDto struct {
	// Filter by an external task's id.
	ExternalTaskId string `json:"externalTaskId,omitempty"`
	// Filter by the comma-separated list of external task ids.
	ExternalTaskIdIn []string `json:"externalTaskIdIn,omitempty"`
	// Filter by an external task topic.
	TopicName string `json:"topicName,omitempty"`
	// Filter by the id of the worker that the task was most recently locked by.
	WorkerId string `json:"workerId,omitempty"`
	// Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task.
	Locked *bool `json:"locked,omitempty"`
	// Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task.
	NotLocked *bool `json:"notLocked,omitempty"`
	// Only include external tasks that have a positive (> 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task.
	WithRetriesLeft *bool `json:"withRetriesLeft,omitempty"`
	// Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task.
	NoRetriesLeft *bool `json:"noRetriesLeft,omitempty"`
	// Restrict to external tasks that have a lock that expires after a given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	LockExpirationAfter *string `json:"lockExpirationAfter,omitempty"`
	// Restrict to external tasks that have a lock that expires before a given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	LockExpirationBefore *string `json:"lockExpirationBefore,omitempty"`
	// Filter by the id of the activity that an external task is created for.
	ActivityId string `json:"activityId,omitempty"`
	// Filter by the comma-separated list of ids of the activities that an external task is created for.
	ActivityIdIn []string `json:"activityIdIn,omitempty"`
	// Filter by the id of the execution that an external task belongs to.
	ExecutionId string `json:"executionId,omitempty"`
	// Filter by the id of the process instance that an external task belongs to.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// Filter by a comma-separated list of process instance ids that an external task may belong to.
	ProcessInstanceIdIn []string `json:"processInstanceIdIn,omitempty"`
	// Filter by the id of the process definition that an external task belongs to.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids.
	TenantIdIn []string `json:"tenantIdIn,omitempty"`
	// Only include active tasks. Value may only be `true`, as `false` matches any external task.
	Active *bool `json:"active,omitempty"`
	// Only include suspended tasks. Value may only be `true`, as `false` matches any external task.
	Suspended *bool `json:"suspended,omitempty"`
	// Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value.
	PriorityHigherThanOrEquals *int64 `json:"priorityHigherThanOrEquals,omitempty"`
	// Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value.
	PriorityLowerThanOrEquals *int64 `json:"priorityLowerThanOrEquals,omitempty"`
	// A JSON array of criteria to sort the result by. Each element of the array is a JSON object that                     specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether                     it is primary, secondary, etc. The ordering objects have the following properties:                      **Note:** The `sorting` properties will not be applied to the External Task count query.
	Sorting []ExternalTaskQueryDtoSorting `json:"sorting,omitempty"`
}

ExternalTaskQueryDto A JSON object with the following properties:

type ExternalTaskQueryDtoSorting

type ExternalTaskQueryDtoSorting struct {
	// Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
	SortBy string `json:"sortBy,omitempty"`
	// Sort the results in a given order. Values may be `asc` for ascending order or `desc` for descending order. Must be used in conjunction with the sortBy parameter.
	SortOrder string `json:"sortOrder,omitempty"`
}

ExternalTaskQueryDtoSorting struct for ExternalTaskQueryDtoSorting

type FetchAndLockOpts

type FetchAndLockOpts struct {
	FetchExternalTasksDto optional.Interface
}

FetchAndLockOpts Optional parameters for the method 'FetchAndLock'

type FetchExternalTaskTopicDto

type FetchExternalTaskTopicDto struct {
	// **Mandatory.** The topic's name.
	TopicName string `json:"topicName"`
	// **Mandatory.** The duration to lock the external tasks for in milliseconds.
	LockDuration *int64 `json:"lockDuration"`
	// A JSON array of `String` values that represent variable names. For each result task belonging to this topic, the given variables are returned as well if they are accessible from the external task's execution. If not provided - all variables will be fetched.
	Variables []string `json:"variables,omitempty"`
	// If `true` only local variables will be fetched.
	LocalVariables *bool `json:"localVariables,omitempty"`
	// A `String` value which enables the filtering of tasks based on process instance business key.
	BusinessKey string `json:"businessKey,omitempty"`
	// Filter tasks based on process definition id.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// Filter tasks based on process definition ids.
	ProcessDefinitionIdIn []string `json:"processDefinitionIdIn,omitempty"`
	// Filter tasks based on process definition key.
	ProcessDefinitionKey string `json:"processDefinitionKey,omitempty"`
	// Filter tasks based on process definition keys.
	ProcessDefinitionKeyIn []string `json:"processDefinitionKeyIn,omitempty"`
	// Filter tasks based on process definition version tag.
	ProcessDefinitionVersionTag string `json:"processDefinitionVersionTag,omitempty"`
	// Filter tasks without tenant id.
	WithoutTenantId *bool `json:"withoutTenantId,omitempty"`
	// Filter tasks based on tenant ids.
	TenantIdIn []string `json:"tenantIdIn,omitempty"`
	// A `JSON` object used for filtering tasks based on process instance variable values. A property name of the object represents a process variable name, while the property value represents the process variable value to filter tasks by.
	ProcessVariables map[string]map[string]interface{} `json:"processVariables,omitempty"`
	// Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `false`).  If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.  If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.
	DeserializeValues *bool `json:"deserializeValues,omitempty"`
}

FetchExternalTaskTopicDto struct for FetchExternalTaskTopicDto

type FetchExternalTasksDto

type FetchExternalTasksDto struct {
	// **Mandatory.** The id of the worker on which behalf tasks are fetched. The returned tasks are locked for that worker and can only be completed when providing the same worker id.
	WorkerId string `json:"workerId"`
	// **Mandatory.** The maximum number of tasks to return.
	MaxTasks *int32 `json:"maxTasks"`
	// A `boolean` value, which indicates whether the task should be fetched based on its priority or arbitrarily.
	UsePriority *bool `json:"usePriority,omitempty"`
	// The [Long Polling](https://docs.camunda.org/manual/7.13/user-guide/process-engine/external-tasks/#long-polling-to-fetch-and-lock-external-tasks) timeout in milliseconds.  **Note:** The value cannot be set larger than 1.800.000 milliseconds (corresponds to 30 minutes).
	AsyncResponseTimeout *int64 `json:"asyncResponseTimeout,omitempty"`
	// A JSON array of topic objects for which external tasks should be fetched. The returned tasks may be arbitrarily distributed among these topics. Each topic object has the following properties:
	Topics []FetchExternalTaskTopicDto `json:"topics,omitempty"`
}

FetchExternalTasksDto struct for FetchExternalTasksDto

type FormDto

type FormDto struct {
	// The form key.
	Key string `json:"key,omitempty"`
	// The context path of the process application. If the task (or the process definition) does not belong to a process application deployment or a process definition at all, this property is not set.
	ContextPath string `json:"contextPath,omitempty"`
}

FormDto struct for FormDto

type GenericOpenAPIError

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetActivityStatisticsByProcessDefinitionKeyAndTenantIdOpts

type GetActivityStatisticsByProcessDefinitionKeyAndTenantIdOpts struct {
	FailedJobs       optional.Bool
	Incidents        optional.Bool
	IncidentsForType optional.String
}

GetActivityStatisticsByProcessDefinitionKeyAndTenantIdOpts Optional parameters for the method 'GetActivityStatisticsByProcessDefinitionKeyAndTenantId'

type GetActivityStatisticsByProcessDefinitionKeyOpts

type GetActivityStatisticsByProcessDefinitionKeyOpts struct {
	FailedJobs       optional.Bool
	Incidents        optional.Bool
	IncidentsForType optional.String
}

GetActivityStatisticsByProcessDefinitionKeyOpts Optional parameters for the method 'GetActivityStatisticsByProcessDefinitionKey'

type GetActivityStatisticsOpts

type GetActivityStatisticsOpts struct {
	FailedJobs       optional.Bool
	Incidents        optional.Bool
	IncidentsForType optional.String
}

GetActivityStatisticsOpts Optional parameters for the method 'GetActivityStatistics'

type GetDeploymentsCountOpts

type GetDeploymentsCountOpts struct {
	Id                                optional.String
	Name                              optional.String
	NameLike                          optional.String
	Source                            optional.String
	WithoutSource                     optional.Bool
	TenantIdIn                        optional.String
	WithoutTenantId                   optional.Bool
	IncludeDeploymentsWithoutTenantId optional.Bool
	After                             optional.String
	Before                            optional.String
}

GetDeploymentsCountOpts Optional parameters for the method 'GetDeploymentsCount'

type GetDeploymentsOpts

type GetDeploymentsOpts struct {
	Id                                optional.String
	Name                              optional.String
	NameLike                          optional.String
	Source                            optional.String
	WithoutSource                     optional.Bool
	TenantIdIn                        optional.String
	WithoutTenantId                   optional.Bool
	IncludeDeploymentsWithoutTenantId optional.Bool
	After                             optional.String
	Before                            optional.String
	SortBy                            optional.String
	SortOrder                         optional.String
	FirstResult                       optional.Int32
	MaxResults                        optional.Int32
}

GetDeploymentsOpts Optional parameters for the method 'GetDeployments'

type GetEventSubscriptionsCountOpts

type GetEventSubscriptionsCountOpts struct {
	EventSubscriptionId                      optional.String
	EventName                                optional.String
	EventType                                optional.String
	ExecutionId                              optional.String
	ProcessInstanceId                        optional.String
	ActivityId                               optional.String
	TenantIdIn                               optional.String
	WithoutTenantId                          optional.Bool
	IncludeEventSubscriptionsWithoutTenantId optional.Bool
}

GetEventSubscriptionsCountOpts Optional parameters for the method 'GetEventSubscriptionsCount'

type GetEventSubscriptionsOpts

type GetEventSubscriptionsOpts struct {
	EventSubscriptionId                      optional.String
	EventName                                optional.String
	EventType                                optional.String
	ExecutionId                              optional.String
	ProcessInstanceId                        optional.String
	ActivityId                               optional.String
	TenantIdIn                               optional.String
	WithoutTenantId                          optional.Bool
	IncludeEventSubscriptionsWithoutTenantId optional.Bool
	SortBy                                   optional.String
	SortOrder                                optional.String
	FirstResult                              optional.Int32
	MaxResults                               optional.Int32
}

GetEventSubscriptionsOpts Optional parameters for the method 'GetEventSubscriptions'

type GetExternalTasksCountOpts

type GetExternalTasksCountOpts struct {
	ExternalTaskId             optional.String
	ExternalTaskIdIn           optional.String
	TopicName                  optional.String
	WorkerId                   optional.String
	Locked                     optional.Bool
	NotLocked                  optional.Bool
	WithRetriesLeft            optional.Bool
	NoRetriesLeft              optional.Bool
	LockExpirationAfter        optional.String
	LockExpirationBefore       optional.String
	ActivityId                 optional.String
	ActivityIdIn               optional.String
	ExecutionId                optional.String
	ProcessInstanceId          optional.String
	ProcessInstanceIdIn        optional.String
	ProcessDefinitionId        optional.String
	TenantIdIn                 optional.String
	Active                     optional.Bool
	Suspended                  optional.Bool
	PriorityHigherThanOrEquals optional.Int64
	PriorityLowerThanOrEquals  optional.Int64
}

GetExternalTasksCountOpts Optional parameters for the method 'GetExternalTasksCount'

type GetExternalTasksOpts

type GetExternalTasksOpts struct {
	ExternalTaskId             optional.String
	ExternalTaskIdIn           optional.String
	TopicName                  optional.String
	WorkerId                   optional.String
	Locked                     optional.Bool
	NotLocked                  optional.Bool
	WithRetriesLeft            optional.Bool
	NoRetriesLeft              optional.Bool
	LockExpirationAfter        optional.String
	LockExpirationBefore       optional.String
	ActivityId                 optional.String
	ActivityIdIn               optional.String
	ExecutionId                optional.String
	ProcessInstanceId          optional.String
	ProcessInstanceIdIn        optional.String
	ProcessDefinitionId        optional.String
	TenantIdIn                 optional.String
	Active                     optional.Bool
	Suspended                  optional.Bool
	PriorityHigherThanOrEquals optional.Int64
	PriorityLowerThanOrEquals  optional.Int64
	SortBy                     optional.String
	SortOrder                  optional.String
	FirstResult                optional.Int32
	MaxResults                 optional.Int32
}

GetExternalTasksOpts Optional parameters for the method 'GetExternalTasks'

type GetFormVariablesOpts

type GetFormVariablesOpts struct {
	VariableNames     optional.String
	DeserializeValues optional.Bool
}

GetFormVariablesOpts Optional parameters for the method 'GetFormVariables'

type GetIdentityLinksOpts

type GetIdentityLinksOpts struct {
	Type_ optional.String
}

GetIdentityLinksOpts Optional parameters for the method 'GetIdentityLinks'

type GetMetricsOpts

type GetMetricsOpts struct {
	StartDate optional.String
	EndDate   optional.String
}

GetMetricsOpts Optional parameters for the method 'GetMetrics'

type GetProcessDefinitionStatisticsOpts

type GetProcessDefinitionStatisticsOpts struct {
	FailedJobs       optional.Bool
	Incidents        optional.Bool
	IncidentsForType optional.String
	RootIncidents    optional.Bool
}

GetProcessDefinitionStatisticsOpts Optional parameters for the method 'GetProcessDefinitionStatistics'

type GetProcessDefinitionsCountOpts

type GetProcessDefinitionsCountOpts struct {
	ProcessDefinitionId                      optional.String
	ProcessDefinitionIdIn                    optional.String
	Name                                     optional.String
	NameLike                                 optional.String
	DeploymentId                             optional.String
	DeployedAfter                            optional.String
	DeployedAt                               optional.String
	Key                                      optional.String
	KeysIn                                   optional.String
	KeyLike                                  optional.String
	Category                                 optional.String
	CategoryLike                             optional.String
	Version                                  optional.Int32
	LatestVersion                            optional.Bool
	ResourceName                             optional.String
	ResourceNameLike                         optional.String
	StartableBy                              optional.String
	Active                                   optional.Bool
	Suspended                                optional.Bool
	IncidentId                               optional.String
	IncidentType                             optional.String
	IncidentMessage                          optional.String
	IncidentMessageLike                      optional.String
	TenantIdIn                               optional.String
	WithoutTenantId                          optional.Bool
	IncludeProcessDefinitionsWithoutTenantId optional.Bool
	VersionTag                               optional.String
	VersionTagLike                           optional.String
	WithoutVersionTag                        optional.Bool
	StartableInTasklist                      optional.Bool
	NotStartableInTasklist                   optional.Bool
	StartablePermissionCheck                 optional.Bool
}

GetProcessDefinitionsCountOpts Optional parameters for the method 'GetProcessDefinitionsCount'

type GetProcessDefinitionsOpts

type GetProcessDefinitionsOpts struct {
	ProcessDefinitionId                      optional.String
	ProcessDefinitionIdIn                    optional.String
	Name                                     optional.String
	NameLike                                 optional.String
	DeploymentId                             optional.String
	DeployedAfter                            optional.String
	DeployedAt                               optional.String
	Key                                      optional.String
	KeysIn                                   optional.String
	KeyLike                                  optional.String
	Category                                 optional.String
	CategoryLike                             optional.String
	Version                                  optional.Int32
	LatestVersion                            optional.Bool
	ResourceName                             optional.String
	ResourceNameLike                         optional.String
	StartableBy                              optional.String
	Active                                   optional.Bool
	Suspended                                optional.Bool
	IncidentId                               optional.String
	IncidentType                             optional.String
	IncidentMessage                          optional.String
	IncidentMessageLike                      optional.String
	TenantIdIn                               optional.String
	WithoutTenantId                          optional.Bool
	IncludeProcessDefinitionsWithoutTenantId optional.Bool
	VersionTag                               optional.String
	VersionTagLike                           optional.String
	WithoutVersionTag                        optional.Bool
	StartableInTasklist                      optional.Bool
	NotStartableInTasklist                   optional.Bool
	StartablePermissionCheck                 optional.Bool
	SortBy                                   optional.String
	SortOrder                                optional.String
	FirstResult                              optional.Int32
	MaxResults                               optional.Int32
}

GetProcessDefinitionsOpts Optional parameters for the method 'GetProcessDefinitions'

type GetProcessInstanceVariableOpts

type GetProcessInstanceVariableOpts struct {
	DeserializeValue optional.Bool
}

GetProcessInstanceVariableOpts Optional parameters for the method 'GetProcessInstanceVariable'

type GetProcessInstanceVariablesOpts

type GetProcessInstanceVariablesOpts struct {
	DeserializeValue optional.Bool
}

GetProcessInstanceVariablesOpts Optional parameters for the method 'GetProcessInstanceVariables'

type GetProcessInstancesCountOpts

type GetProcessInstancesCountOpts struct {
	ProcessInstanceIds               optional.String
	BusinessKey                      optional.String
	BusinessKeyLike                  optional.String
	CaseInstanceId                   optional.String
	ProcessDefinitionId              optional.String
	ProcessDefinitionKey             optional.String
	ProcessDefinitionKeyIn           optional.String
	ProcessDefinitionKeyNotIn        optional.String
	DeploymentId                     optional.String
	SuperProcessInstance             optional.String
	SubProcessInstance               optional.String
	SuperCaseInstance                optional.String
	SubCaseInstance                  optional.String
	Active                           optional.Bool
	Suspended                        optional.Bool
	WithIncident                     optional.Bool
	IncidentId                       optional.String
	IncidentType                     optional.String
	IncidentMessage                  optional.String
	IncidentMessageLike              optional.String
	TenantIdIn                       optional.String
	WithoutTenantId                  optional.Bool
	ProcessDefinitionWithoutTenantId optional.Bool
	ActivityIdIn                     optional.String
	RootProcessInstances             optional.Bool
	LeafProcessInstances             optional.Bool
	Variables                        optional.String
	VariableNamesIgnoreCase          optional.Bool
	VariableValuesIgnoreCase         optional.Bool
}

GetProcessInstancesCountOpts Optional parameters for the method 'GetProcessInstancesCount'

type GetProcessInstancesOpts

type GetProcessInstancesOpts struct {
	SortBy                           optional.String
	SortOrder                        optional.String
	FirstResult                      optional.Int32
	MaxResults                       optional.Int32
	ProcessInstanceIds               optional.String
	BusinessKey                      optional.String
	BusinessKeyLike                  optional.String
	CaseInstanceId                   optional.String
	ProcessDefinitionId              optional.String
	ProcessDefinitionKey             optional.String
	ProcessDefinitionKeyIn           optional.String
	ProcessDefinitionKeyNotIn        optional.String
	DeploymentId                     optional.String
	SuperProcessInstance             optional.String
	SubProcessInstance               optional.String
	SuperCaseInstance                optional.String
	SubCaseInstance                  optional.String
	Active                           optional.Bool
	Suspended                        optional.Bool
	WithIncident                     optional.Bool
	IncidentId                       optional.String
	IncidentType                     optional.String
	IncidentMessage                  optional.String
	IncidentMessageLike              optional.String
	TenantIdIn                       optional.String
	WithoutTenantId                  optional.Bool
	ProcessDefinitionWithoutTenantId optional.Bool
	ActivityIdIn                     optional.String
	RootProcessInstances             optional.Bool
	LeafProcessInstances             optional.Bool
	Variables                        optional.String
	VariableNamesIgnoreCase          optional.Bool
	VariableValuesIgnoreCase         optional.Bool
}

GetProcessInstancesOpts Optional parameters for the method 'GetProcessInstances'

type GetSchemaLogOpts

type GetSchemaLogOpts struct {
	Version     optional.String
	FirstResult optional.Int32
	MaxResults  optional.Int32
}

GetSchemaLogOpts Optional parameters for the method 'GetSchemaLog'

type GetStartFormVariablesByKeyAndTenantIdOpts

type GetStartFormVariablesByKeyAndTenantIdOpts struct {
	VariableNames     optional.String
	DeserializeValues optional.Bool
}

GetStartFormVariablesByKeyAndTenantIdOpts Optional parameters for the method 'GetStartFormVariablesByKeyAndTenantId'

type GetStartFormVariablesByKeyOpts

type GetStartFormVariablesByKeyOpts struct {
	VariableNames     optional.String
	DeserializeValues optional.Bool
}

GetStartFormVariablesByKeyOpts Optional parameters for the method 'GetStartFormVariablesByKey'

type GetStartFormVariablesOpts

type GetStartFormVariablesOpts struct {
	VariableNames     optional.String
	DeserializeValues optional.Bool
}

GetStartFormVariablesOpts Optional parameters for the method 'GetStartFormVariables'

type GetTaskLocalVariableOpts

type GetTaskLocalVariableOpts struct {
	DeserializeValue optional.Bool
}

GetTaskLocalVariableOpts Optional parameters for the method 'GetTaskLocalVariable'

type GetTaskLocalVariablesOpts

type GetTaskLocalVariablesOpts struct {
	DeserializeValues optional.Bool
}

GetTaskLocalVariablesOpts Optional parameters for the method 'GetTaskLocalVariables'

type GetTaskVariableOpts

type GetTaskVariableOpts struct {
	DeserializeValue optional.Bool
}

GetTaskVariableOpts Optional parameters for the method 'GetTaskVariable'

type GetTaskVariablesOpts

type GetTaskVariablesOpts struct {
	DeserializeValue optional.Bool
}

GetTaskVariablesOpts Optional parameters for the method 'GetTaskVariables'

type GetTasksCountOpts

type GetTasksCountOpts struct {
	ProcessInstanceId                        optional.String
	ProcessInstanceIdIn                      optional.String
	ProcessInstanceBusinessKey               optional.String
	ProcessInstanceBusinessKeyExpression     optional.String
	ProcessInstanceBusinessKeyIn             optional.String
	ProcessInstanceBusinessKeyLike           optional.String
	ProcessInstanceBusinessKeyLikeExpression optional.String
	ProcessDefinitionId                      optional.String
	ProcessDefinitionKey                     optional.String
	ProcessDefinitionKeyIn                   optional.String
	ProcessDefinitionName                    optional.String
	ProcessDefinitionNameLike                optional.String
	ExecutionId                              optional.String
	CaseInstanceId                           optional.String
	CaseInstanceBusinessKey                  optional.String
	CaseInstanceBusinessKeyLike              optional.String
	CaseDefinitionId                         optional.String
	CaseDefinitionKey                        optional.String
	CaseDefinitionName                       optional.String
	CaseDefinitionNameLike                   optional.String
	CaseExecutionId                          optional.String
	ActivityInstanceIdIn                     optional.String
	TenantIdIn                               optional.String
	WithoutTenantId                          optional.Bool
	Assignee                                 optional.String
	AssigneeExpression                       optional.String
	AssigneeLike                             optional.String
	AssigneeLikeExpression                   optional.String
	AssigneeIn                               optional.String
	Owner                                    optional.String
	OwnerExpression                          optional.String
	CandidateGroup                           optional.String
	CandidateGroupExpression                 optional.String
	CandidateUser                            optional.String
	CandidateUserExpression                  optional.String
	IncludeAssignedTasks                     optional.Bool
	InvolvedUser                             optional.String
	InvolvedUserExpression                   optional.String
	Assigned                                 optional.Bool
	Unassigned                               optional.Bool
	TaskDefinitionKey                        optional.String
	TaskDefinitionKeyIn                      optional.String
	TaskDefinitionKeyLike                    optional.String
	Name                                     optional.String
	NameNotEqual                             optional.String
	NameLike                                 optional.String
	NameNotLike                              optional.String
	Description                              optional.String
	DescriptionLike                          optional.String
	Priority                                 optional.Int32
	MaxPriority                              optional.Int32
	MinPriority                              optional.Int32
	DueDate                                  optional.String
	DueDateExpression                        optional.String
	DueAfter                                 optional.String
	DueAfterExpression                       optional.String
	DueBefore                                optional.String
	DueBeforeExpression                      optional.String
	FollowUpDate                             optional.String
	FollowUpDateExpression                   optional.String
	FollowUpAfter                            optional.String
	FollowUpAfterExpression                  optional.String
	FollowUpBefore                           optional.String
	FollowUpBeforeExpression                 optional.String
	FollowUpBeforeOrNotExistent              optional.String
	FollowUpBeforeOrNotExistentExpression    optional.String
	CreatedOn                                optional.String
	CreatedOnExpression                      optional.String
	CreatedAfter                             optional.String
	CreatedAfterExpression                   optional.String
	CreatedBefore                            optional.String
	CreatedBeforeExpression                  optional.String
	DelegationState                          optional.String
	CandidateGroups                          optional.String
	CandidateGroupsExpression                optional.String
	WithCandidateGroups                      optional.Bool
	WithoutCandidateGroups                   optional.Bool
	WithCandidateUsers                       optional.Bool
	WithoutCandidateUsers                    optional.Bool
	Active                                   optional.Bool
	Suspended                                optional.Bool
	TaskVariables                            optional.String
	ProcessVariables                         optional.String
	CaseInstanceVariables                    optional.String
	VariableNamesIgnoreCase                  optional.Bool
	VariableValuesIgnoreCase                 optional.Bool
	ParentTaskId                             optional.String
}

GetTasksCountOpts Optional parameters for the method 'GetTasksCount'

type GetTasksOpts

type GetTasksOpts struct {
	ProcessInstanceId                        optional.String
	ProcessInstanceIdIn                      optional.String
	ProcessInstanceBusinessKey               optional.String
	ProcessInstanceBusinessKeyExpression     optional.String
	ProcessInstanceBusinessKeyIn             optional.String
	ProcessInstanceBusinessKeyLike           optional.String
	ProcessInstanceBusinessKeyLikeExpression optional.String
	ProcessDefinitionId                      optional.String
	ProcessDefinitionKey                     optional.String
	ProcessDefinitionKeyIn                   optional.String
	ProcessDefinitionName                    optional.String
	ProcessDefinitionNameLike                optional.String
	ExecutionId                              optional.String
	CaseInstanceId                           optional.String
	CaseInstanceBusinessKey                  optional.String
	CaseInstanceBusinessKeyLike              optional.String
	CaseDefinitionId                         optional.String
	CaseDefinitionKey                        optional.String
	CaseDefinitionName                       optional.String
	CaseDefinitionNameLike                   optional.String
	CaseExecutionId                          optional.String
	ActivityInstanceIdIn                     optional.String
	TenantIdIn                               optional.String
	WithoutTenantId                          optional.Bool
	Assignee                                 optional.String
	AssigneeExpression                       optional.String
	AssigneeLike                             optional.String
	AssigneeLikeExpression                   optional.String
	AssigneeIn                               optional.String
	Owner                                    optional.String
	OwnerExpression                          optional.String
	CandidateGroup                           optional.String
	CandidateGroupExpression                 optional.String
	CandidateUser                            optional.String
	CandidateUserExpression                  optional.String
	IncludeAssignedTasks                     optional.Bool
	InvolvedUser                             optional.String
	InvolvedUserExpression                   optional.String
	Assigned                                 optional.Bool
	Unassigned                               optional.Bool
	TaskDefinitionKey                        optional.String
	TaskDefinitionKeyIn                      optional.String
	TaskDefinitionKeyLike                    optional.String
	Name                                     optional.String
	NameNotEqual                             optional.String
	NameLike                                 optional.String
	NameNotLike                              optional.String
	Description                              optional.String
	DescriptionLike                          optional.String
	Priority                                 optional.Int32
	MaxPriority                              optional.Int32
	MinPriority                              optional.Int32
	DueDate                                  optional.String
	DueDateExpression                        optional.String
	DueAfter                                 optional.String
	DueAfterExpression                       optional.String
	DueBefore                                optional.String
	DueBeforeExpression                      optional.String
	FollowUpDate                             optional.String
	FollowUpDateExpression                   optional.String
	FollowUpAfter                            optional.String
	FollowUpAfterExpression                  optional.String
	FollowUpBefore                           optional.String
	FollowUpBeforeExpression                 optional.String
	FollowUpBeforeOrNotExistent              optional.String
	FollowUpBeforeOrNotExistentExpression    optional.String
	CreatedOn                                optional.String
	CreatedOnExpression                      optional.String
	CreatedAfter                             optional.String
	CreatedAfterExpression                   optional.String
	CreatedBefore                            optional.String
	CreatedBeforeExpression                  optional.String
	DelegationState                          optional.String
	CandidateGroups                          optional.String
	CandidateGroupsExpression                optional.String
	WithCandidateGroups                      optional.Bool
	WithoutCandidateGroups                   optional.Bool
	WithCandidateUsers                       optional.Bool
	WithoutCandidateUsers                    optional.Bool
	Active                                   optional.Bool
	Suspended                                optional.Bool
	TaskVariables                            optional.String
	ProcessVariables                         optional.String
	CaseInstanceVariables                    optional.String
	VariableNamesIgnoreCase                  optional.Bool
	VariableValuesIgnoreCase                 optional.Bool
	ParentTaskId                             optional.String
	SortBy                                   optional.String
	SortOrder                                optional.String
	FirstResult                              optional.Int32
	MaxResults                               optional.Int32
}

GetTasksOpts Optional parameters for the method 'GetTasks'

type GetTopicNamesOpts

type GetTopicNamesOpts struct {
	WithLockedTasks   optional.Bool
	WithUnlockedTasks optional.Bool
	WithRetriesLeft   optional.Bool
}

GetTopicNamesOpts Optional parameters for the method 'GetTopicNames'

type HandleBpmnErrorOpts

type HandleBpmnErrorOpts struct {
	TaskBpmnErrorDto optional.Interface
}

HandleBpmnErrorOpts Optional parameters for the method 'HandleBpmnError'

type HandleEscalationOpts

type HandleEscalationOpts struct {
	TaskEscalationDto optional.Interface
}

HandleEscalationOpts Optional parameters for the method 'HandleEscalation'

type HandleExternalTaskBpmnErrorOpts

type HandleExternalTaskBpmnErrorOpts struct {
	ExternalTaskBpmnError optional.Interface
}

HandleExternalTaskBpmnErrorOpts Optional parameters for the method 'HandleExternalTaskBpmnError'

type HandleFailureOpts

type HandleFailureOpts struct {
	ExternalTaskFailureDto optional.Interface
}

HandleFailureOpts Optional parameters for the method 'HandleFailure'

type HistoricProcessInstanceQueryDto

type HistoricProcessInstanceQueryDto struct {
	// Filter by process instance id.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// Filter by process instance ids. Must be a JSON array process instance ids.
	ProcessInstanceIds []string `json:"processInstanceIds,omitempty"`
	// Filter by the process definition the instances run on.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// Filter by the key of the process definition the instances run on.
	ProcessDefinitionKey string `json:"processDefinitionKey,omitempty"`
	// Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Must be a JSON array of Strings.
	ProcessDefinitionKeyIn []string `json:"processDefinitionKeyIn,omitempty"`
	// Filter by the name of the process definition the instances run on.
	ProcessDefinitionName string `json:"processDefinitionName,omitempty"`
	// Filter by process definition names that the parameter is a substring of.
	ProcessDefinitionNameLike string `json:"processDefinitionNameLike,omitempty"`
	// Exclude instances that belong to a set of process definitions. Must be a JSON array of process definition keys.
	ProcessDefinitionKeyNotIn []string `json:"processDefinitionKeyNotIn,omitempty"`
	// Filter by process instance business key.
	ProcessInstanceBusinessKey string `json:"processInstanceBusinessKey,omitempty"`
	// Filter by process instance business key that the parameter is a substring of.
	ProcessInstanceBusinessKeyLike string `json:"processInstanceBusinessKeyLike,omitempty"`
	// Restrict the query to all process instances that are top level process instances.
	RootProcessInstances *bool `json:"rootProcessInstances,omitempty"`
	// Only include finished process instances. Value may only be true, as false is the default behavior.
	Finished *bool `json:"finished,omitempty"`
	// Only include unfinished process instances. Value may only be true, as false is the default behavior.
	Unfinished *bool `json:"unfinished,omitempty"`
	// Only include process instances which have an incident. Value may only be true, as false is the default behavior.
	WithIncidents *bool `json:"withIncidents,omitempty"`
	// Only include process instances which have a root incident. Value may only be true, as false is the default behavior.
	WithRootIncidents *bool `json:"withRootIncidents,omitempty"`
	// Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types.
	IncidentType string `json:"incidentType,omitempty"`
	// Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents.
	IncidentStatus string `json:"incidentStatus,omitempty"`
	// Filter by the incident message. Exact match.
	IncidentMessage string `json:"incidentMessage,omitempty"`
	// Filter by the incident message that the parameter is a substring of.
	IncidentMessageLike string `json:"incidentMessageLike,omitempty"`
	// Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format yyyy-MM-dd' 'HH:mm:ss, e.g., 2013-01-23 14:42:45.
	StartedBefore *string `json:"startedBefore,omitempty"`
	// Restrict to instances that were started after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format yyyy-MM-dd' 'HH:mm:ss, e.g., 2013-01-23 14:42:45.
	StartedAfter *string `json:"startedAfter,omitempty"`
	// Restrict to instances that were finished before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format yyyy-MM-dd' 'HH:mm:ss, e.g., 2013-01-23 14:42:45.
	FinishedBefore *string `json:"finishedBefore,omitempty"`
	// Restrict to instances that were finished after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format yyyy-MM-dd' 'HH:mm:ss, e.g., 2013-01-23 14:42:45.
	FinishedAfter *string `json:"finishedAfter,omitempty"`
	// Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format yyyy-MM-dd' 'HH:mm:ss, e.g., 2013-01-23 14:42:45.
	ExecutedActivityAfter *string `json:"executedActivityAfter,omitempty"`
	// Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format yyyy-MM-dd' 'HH:mm:ss, e.g., 2013-01-23 14:42:45.
	ExecutedActivityBefore *string `json:"executedActivityBefore,omitempty"`
	// Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format yyyy-MM-dd' 'HH:mm:ss, e.g., 2013-01-23 14:42:45.
	ExecutedJobAfter *string `json:"executedJobAfter,omitempty"`
	// Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format yyyy-MM-dd' 'HH:mm:ss, e.g., 2013-01-23 14:42:45.
	ExecutedJobBefore *string `json:"executedJobBefore,omitempty"`
	// Only include process instances that were started by the given user.
	StartedBy string `json:"startedBy,omitempty"`
	// Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id.
	SuperProcessInstanceId string `json:"superProcessInstanceId,omitempty"`
	// Restrict query to one process instance that has a sub process instance with the given id.
	SubProcessInstanceId string `json:"subProcessInstanceId,omitempty"`
	// Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
	SuperCaseInstanceId string `json:"superCaseInstanceId,omitempty"`
	// Restrict query to one process instance that has a sub case instance with the given id.
	SubCaseInstanceId string `json:"subCaseInstanceId,omitempty"`
	// Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
	CaseInstanceId string `json:"caseInstanceId,omitempty"`
	// Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Must be a JSON array of Strings.
	TenantIdIn []string `json:"tenantIdIn,omitempty"`
	// Only include historic process instances which belong to no tenant. Value may only be true, as false is the default behavior.
	WithoutTenantId *bool `json:"withoutTenantId,omitempty"`
	// Restrict to instances that executed an activity with one of given ids.
	ExecutedActivityIdIn []string `json:"executedActivityIdIn,omitempty"`
	// Restrict to instances that have an active activity with one of given ids.
	ActiveActivityIdIn []string `json:"activeActivityIdIn,omitempty"`
	// Restrict to instances that are active.
	Active *bool `json:"active,omitempty"`
	// Restrict to instances that are suspended.
	Suspended *bool `json:"suspended,omitempty"`
	// Restrict to instances that are completed.
	Completed *bool `json:"completed,omitempty"`
	// Restrict to instances that are externallyTerminated.
	ExternallyTerminated *bool `json:"externallyTerminated,omitempty"`
	// Restrict to instances that are internallyTerminated.
	InternallyTerminated *bool `json:"internallyTerminated,omitempty"`
	// A JSON array to only include process instances that have/had variables with certain values. The array consists of objects with the three properties `name`, `operator` and `value`. `name` (String) is the variable name, `operator` (String) is the comparison operator to be used and `value` the variable value. `value` may be String, Number or Boolean. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`.
	Variables []VariableQueryParameterDto `json:"variables,omitempty"`
	// Match all variable names provided in variables case-insensitively. If set to true variableName and variablename are treated as equal.
	VariableNamesIgnoreCase *bool `json:"variableNamesIgnoreCase,omitempty"`
	// Match all variable values provided in variables case-insensitively. If set to true variableValue and variablevalue are treated as equal.
	VariableValuesIgnoreCase *bool `json:"variableValuesIgnoreCase,omitempty"`
	// A JSON array of nested historic process instance queries with OR semantics. A process instance matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a process instance must fulfill at least one predicate of each query (Conjunctive Normal Form). All process instance query properties can be used except for: sorting See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/process-engine-api/#or-queries) for more information about OR queries.
	OrQueries []HistoricProcessInstanceQueryDto `json:"orQueries,omitempty"`
	// Apply sorting of the result
	Sorting []HistoricProcessInstanceQueryDtoSorting `json:"sorting,omitempty"`
}

HistoricProcessInstanceQueryDto A historic process instance query which defines a group of historic process instances

type HistoricProcessInstanceQueryDtoSorting

type HistoricProcessInstanceQueryDtoSorting struct {
	// Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
	SortBy string `json:"sortBy,omitempty"`
	// Sort the results in a given order. Values may be `asc` for ascending order or `desc` for descending order. Must be used in conjunction with the sortBy parameter.
	SortOrder string `json:"sortOrder,omitempty"`
}

HistoricProcessInstanceQueryDtoSorting struct for HistoricProcessInstanceQueryDtoSorting

type HistoryTimeToLiveDto

type HistoryTimeToLiveDto struct {
	// New value for historyTimeToLive field of the definition. Can be `null`. Can not be negative.
	HistoryTimeToLive *int32 `json:"historyTimeToLive,omitempty"`
}

HistoryTimeToLiveDto struct for HistoryTimeToLiveDto

type IdentityLinkDto

type IdentityLinkDto struct {
	// The id of the user participating in this link. Either `userId` or `groupId` is set.
	UserId string `json:"userId,omitempty"`
	// The id of the group participating in this link. Either `groupId` or `userId` is set.
	GroupId string `json:"groupId,omitempty"`
	// The type of the identity link. The value of the this property can be user-defined. The Process Engine provides three pre-defined Identity Link `type`s:  * `candidate` * `assignee` - reserved for the task assignee * `owner` - reserved for the task owner  **Note**: When adding or removing an Identity Link, the `type` property must be defined.
	Type string `json:"type"`
}

IdentityLinkDto struct for IdentityLinkDto

type IncidentStatisticsResultDto

type IncidentStatisticsResultDto struct {
	// The type of the incident the number of incidents is aggregated for. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types.
	IncidentType string `json:"incidentType,omitempty"`
	// The total number of incidents for the corresponding incident type.
	IncidentCount int32 `json:"incidentCount,omitempty"`
}

IncidentStatisticsResultDto struct for IncidentStatisticsResultDto

type IntervalOpts

type IntervalOpts struct {
	Name                optional.String
	Reporter            optional.String
	StartDate           optional.String
	EndDate             optional.String
	FirstResult         optional.Int32
	MaxResults          optional.Int32
	Interval            optional.String
	AggregateByReporter optional.String
}

IntervalOpts Optional parameters for the method 'Interval'

type LinkableDto

type LinkableDto struct {
	// The links associated to this resource, with `method`, `href` and `rel`.
	Links []AtomLink `json:"links,omitempty"`
}

LinkableDto struct for LinkableDto

type LockedExternalTaskDto

type LockedExternalTaskDto struct {
	// The id of the activity that this external task belongs to.
	ActivityId string `json:"activityId,omitempty"`
	// The id of the activity instance that the external task belongs to.
	ActivityInstanceId string `json:"activityInstanceId,omitempty"`
	// The full error message submitted with the latest reported failure executing this task;`null` if no failure was reported previously or if no error message was submitted
	ErrorMessage string `json:"errorMessage,omitempty"`
	// The error details submitted with the latest reported failure executing this task.`null` if no failure was reported previously or if no error details was submitted
	ErrorDetails string `json:"errorDetails,omitempty"`
	// The id of the execution that the external task belongs to.
	ExecutionId string `json:"executionId,omitempty"`
	// The id of the external task.
	Id string `json:"id,omitempty"`
	// The date that the task's most recent lock expires or has expired.
	LockExpirationTime *string `json:"lockExpirationTime,omitempty"`
	// The id of the process definition the external task is defined in.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// The key of the process definition the external task is defined in.
	ProcessDefinitionKey string `json:"processDefinitionKey,omitempty"`
	// The version tag of the process definition the external task is defined in.
	ProcessDefinitionVersionTag string `json:"processDefinitionVersionTag,omitempty"`
	// The id of the process instance the external task belongs to.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// The id of the tenant the external task belongs to.
	TenantId string `json:"tenantId,omitempty"`
	// The number of retries the task currently has left.
	Retries *int32 `json:"retries,omitempty"`
	// Whether the process instance the external task belongs to is suspended.
	Suspended *bool `json:"suspended,omitempty"`
	// The id of the worker that posesses or posessed the most recent lock.
	WorkerId string `json:"workerId,omitempty"`
	// The priority of the external task.
	Priority *int64 `json:"priority,omitempty"`
	// The topic name of the external task.
	TopicName string `json:"topicName,omitempty"`
	// The business key of the process instance the external task belongs to.
	BusinessKey string `json:"businessKey,omitempty"`
	// A JSON object containing a property for each of the requested variables. The key is the variable name, the value is a JSON object of serialized variable values with the following properties:
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
}

LockedExternalTaskDto struct for LockedExternalTaskDto

type MessageApiService

type MessageApiService service

MessageApiService MessageApi service

func (*MessageApiService) DeliverMessage

DeliverMessage Method for DeliverMessage Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event. Internally this maps to the engine's message correlation builder methods `MessageCorrelationBuilder#correlateWithResult()` and `MessageCorrelationBuilder#correlateAllWithResult()`. For more information about the correlation behavior, see the [Message Events](https://docs.camunda.org/manual/7.13/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.13/reference/bpmn20/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DeliverMessageOpts - Optional Parameters:
  • @param "CorrelationMessageDto" (optional.Interface of CorrelationMessageDto) -

@return []MessageCorrelationResultWithVariableDto

type MessageCorrelationResultWithVariableDto

type MessageCorrelationResultWithVariableDto struct {
	// Indicates if the message was correlated to a message start event or an  intermediate message catching event. In the first case, the resultType is  `ProcessDefinition` and otherwise `Execution`.
	ResultType      string             `json:"resultType,omitempty"`
	ProcessInstance ProcessInstanceDto `json:"processInstance,omitempty"`
	Execution       ExecutionDto       `json:"execution,omitempty"`
	// This property is returned if the `variablesInResultEnabled` is set to `true`. Contains a list of the process variables.
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
}

MessageCorrelationResultWithVariableDto The `processInstance` property only has a value if the resultType is set to `ProcessDefinition`. The processInstance with the properties as described in the [get single instance](https://docs.camunda.org/manual/7.13/reference/rest/process-instance/get/) method. The `execution` property only has a value if the resultType is set to `Execution`. The execution with the properties as described in the [get single execution](https://docs.camunda.org/manual/7.13/reference/rest/execution/get/) method.

type MetricsApiService

type MetricsApiService service

MetricsApiService MetricsApi service

func (*MetricsApiService) GetMetrics

func (a *MetricsApiService) GetMetrics(ctx _context.Context, metricsName string, localVarOptionals *GetMetricsOpts) (MetricsResultDto, *_nethttp.Response, error)

GetMetrics Method for GetMetrics Retrieves the `sum` (count) for a given metric.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param metricsName The name of the metric.
  • @param optional nil or *GetMetricsOpts - Optional Parameters:
  • @param "StartDate" (optional.String) - The start date (inclusive).
  • @param "EndDate" (optional.String) - The end date (exclusive).

@return MetricsResultDto

func (*MetricsApiService) Interval

func (a *MetricsApiService) Interval(ctx _context.Context, localVarOptionals *IntervalOpts) ([]MetricsIntervalResultDto, *_nethttp.Response, error)

Interval Method for Interval Retrieves a list of metrics, aggregated for a given interval.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *IntervalOpts - Optional Parameters:
  • @param "Name" (optional.String) - The name of the metric.
  • @param "Reporter" (optional.String) - The name of the reporter (host), on which the metrics was logged. This will have value provided by the [hostname configuration property](https://docs.camunda.org/manual/7.13/reference/deployment-descriptors/tags/process-engine/#hostname).
  • @param "StartDate" (optional.String) - The start date (inclusive).
  • @param "EndDate" (optional.String) - The end date (exclusive).
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
  • @param "Interval" (optional.String) - The interval for which the metrics should be aggregated. Time unit is seconds. Default: The interval is set to 15 minutes (900 seconds).
  • @param "AggregateByReporter" (optional.String) - Aggregate metrics by reporter.

@return []MetricsIntervalResultDto

type MetricsIntervalResultDto

type MetricsIntervalResultDto struct {
	// The interval timestamp.
	Timestamp string `json:"timestamp,omitempty"`
	// The name of the metric.
	Name string `json:"name,omitempty"`
	// The reporter of the metric. `null` if the metrics are aggregated by reporter.
	Reporter string `json:"reporter,omitempty"`
	// The value of the metric aggregated by the interval.
	Value int64 `json:"value,omitempty"`
}

MetricsIntervalResultDto struct for MetricsIntervalResultDto

type MetricsResultDto

type MetricsResultDto struct {
	// The current sum (count) for the selected metric.
	Result int64 `json:"result,omitempty"`
}

MetricsResultDto struct for MetricsResultDto

type MissingAuthorizationDto

type MissingAuthorizationDto struct {
	// The permission name that the user is missing.
	PermissionName string `json:"permissionName,omitempty"`
	// The name of the resource that the user is missing permission for.
	ResourceName string `json:"resourceName,omitempty"`
	// The id of the resource that the user is missing permission for.
	ResourceId string `json:"resourceId,omitempty"`
}

MissingAuthorizationDto struct for MissingAuthorizationDto

type ModifyProcessInstanceAsyncOperationOpts

type ModifyProcessInstanceAsyncOperationOpts struct {
	ProcessInstanceModificationDto optional.Interface
}

ModifyProcessInstanceAsyncOperationOpts Optional parameters for the method 'ModifyProcessInstanceAsyncOperation'

type ModifyProcessInstanceOpts

type ModifyProcessInstanceOpts struct {
	ProcessInstanceModificationDto optional.Interface
}

ModifyProcessInstanceOpts Optional parameters for the method 'ModifyProcessInstance'

type ModifyProcessInstanceVariablesOpts

type ModifyProcessInstanceVariablesOpts struct {
	PatchVariablesDto optional.Interface
}

ModifyProcessInstanceVariablesOpts Optional parameters for the method 'ModifyProcessInstanceVariables'

type ModifyTaskLocalVariablesOpts

type ModifyTaskLocalVariablesOpts struct {
	PatchVariablesDto optional.Interface
}

ModifyTaskLocalVariablesOpts Optional parameters for the method 'ModifyTaskLocalVariables'

type ModifyTaskVariablesOpts

type ModifyTaskVariablesOpts struct {
	PatchVariablesDto optional.Interface
}

ModifyTaskVariablesOpts Optional parameters for the method 'ModifyTaskVariables'

type MultiFormAttachmentDto

type MultiFormAttachmentDto struct {
	// The name of the attachment.
	AttachmentName string `json:"attachment-name,omitempty"`
	// The description of the attachment.
	AttachmentDescription string `json:"attachment-description,omitempty"`
	// The type of the attachment.
	AttachmentType string `json:"attachment-type,omitempty"`
	// The url to the remote content of the attachment.
	Url string `json:"url,omitempty"`
	// The content of the attachment.
	Content **os.File `json:"content,omitempty"`
}

MultiFormAttachmentDto struct for MultiFormAttachmentDto

type MultiFormDeploymentDto

type MultiFormDeploymentDto struct {
	// The tenant id for the deployment to be created.
	TenantId string `json:"tenant-id,omitempty"`
	// The source for the deployment to be created.
	DeploymentSource string `json:"deployment-source,omitempty"`
	// A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true.
	DeployChangedOnly *bool `json:"deploy-changed-only,omitempty"`
	// A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false.
	EnableDuplicateFiltering *bool `json:"enable-duplicate-filtering,omitempty"`
	// The name for the deployment to be created.
	DeploymentName string `json:"deployment-name,omitempty"`
	// The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment.
	Data **os.File `json:"data,omitempty"`
}

MultiFormDeploymentDto struct for MultiFormDeploymentDto

type MultiFormVariableBinaryDto

type MultiFormVariableBinaryDto struct {
	// The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory.
	Data **os.File `json:"data,omitempty"`
	// The name of the variable type. Either Bytes for a byte array variable or File for a file variable.
	ValueType string `json:"valueType,omitempty"`
}

MultiFormVariableBinaryDto struct for MultiFormVariableBinaryDto

type ParseExceptionDto

type ParseExceptionDto struct {
	// A JSON Object containing list of errors and warnings occurred during deployment.
	Details map[string]ResourceReportDto `json:"details,omitempty"`
	// An exception class indicating the occurred error.
	Type string `json:"type,omitempty"`
	// A detailed message of the error.
	Message string `json:"message,omitempty"`
}

ParseExceptionDto struct for ParseExceptionDto

type ParseExceptionDtoAllOf

type ParseExceptionDtoAllOf struct {
	// A JSON Object containing list of errors and warnings occurred during deployment.
	Details map[string]ResourceReportDto `json:"details,omitempty"`
}

ParseExceptionDtoAllOf struct for ParseExceptionDtoAllOf

type PatchVariablesDto

type PatchVariablesDto struct {
	// A JSON object containing variable key-value pairs.
	Modifications map[string]VariableValueDto `json:"modifications,omitempty"`
	// An array of String keys of variables to be deleted.
	Deletions []string `json:"deletions,omitempty"`
}

PatchVariablesDto struct for PatchVariablesDto

type PriorityDto

type PriorityDto struct {
	// The priority of the resource.
	Priority *int64 `json:"priority,omitempty"`
}

PriorityDto struct for PriorityDto

type ProblemDto

type ProblemDto struct {
	// The message of the problem.
	Message string `json:"message,omitempty"`
	// The line where the problem occurred.
	Line *int32 `json:"line,omitempty"`
	// The column where the problem occurred.
	Column *int32 `json:"column,omitempty"`
	// The main element id where the problem occurred.
	MainElementId string `json:"mainElementId,omitempty"`
	// A list of element id affected by the problem.
	ElementIds []string `json:"elementIds,omitempty"`
}

ProblemDto struct for ProblemDto

type ProcessDefinitionApiService

type ProcessDefinitionApiService service

ProcessDefinitionApiService ProcessDefinitionApi service

func (*ProcessDefinitionApiService) DeleteProcessDefinition

func (a *ProcessDefinitionApiService) DeleteProcessDefinition(ctx _context.Context, id string, localVarOptionals *DeleteProcessDefinitionOpts) (*_nethttp.Response, error)

DeleteProcessDefinition Delete Deletes a running process instance by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition to be deleted.
  • @param optional nil or *DeleteProcessDefinitionOpts - Optional Parameters:
  • @param "Cascade" (optional.Bool) - `true`, if all process instances, historic process instances and jobs for this process definition should be deleted.
  • @param "SkipCustomListeners" (optional.Bool) - `true`, if only the built-in ExecutionListeners should be notified with the end event.
  • @param "SkipIoMappings" (optional.Bool) - A boolean value to control whether input/output mappings should be executed during deletion. `true`, if input/output mappings should not be invoked.

func (*ProcessDefinitionApiService) DeleteProcessDefinitionsByKey

func (a *ProcessDefinitionApiService) DeleteProcessDefinitionsByKey(ctx _context.Context, key string, localVarOptionals *DeleteProcessDefinitionsByKeyOpts) (*_nethttp.Response, error)

DeleteProcessDefinitionsByKey Delete By Key Deletes process definitions by a given key which belong to no tenant id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definitions to be deleted.
  • @param optional nil or *DeleteProcessDefinitionsByKeyOpts - Optional Parameters:
  • @param "Cascade" (optional.Bool) - `true`, if all process instances, historic process instances and jobs for this process definition should be deleted.
  • @param "SkipCustomListeners" (optional.Bool) - `true`, if only the built-in ExecutionListeners should be notified with the end event.
  • @param "SkipIoMappings" (optional.Bool) - A boolean value to control whether input/output mappings should be executed during deletion. `true`, if input/output mappings should not be invoked.

func (*ProcessDefinitionApiService) DeleteProcessDefinitionsByKeyAndTenantId

func (a *ProcessDefinitionApiService) DeleteProcessDefinitionsByKeyAndTenantId(ctx _context.Context, key string, tenantId string, localVarOptionals *DeleteProcessDefinitionsByKeyAndTenantIdOpts) (*_nethttp.Response, error)

DeleteProcessDefinitionsByKeyAndTenantId Delete By Key Deletes process definitions by a given key and which belong to a tenant id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definitions to be deleted.
  • @param tenantId The id of the tenant the process definitions belong to.
  • @param optional nil or *DeleteProcessDefinitionsByKeyAndTenantIdOpts - Optional Parameters:
  • @param "Cascade" (optional.Bool) - `true`, if all process instances, historic process instances and jobs for this process definition should be deleted.
  • @param "SkipCustomListeners" (optional.Bool) - `true`, if only the built-in ExecutionListeners should be notified with the end event.
  • @param "SkipIoMappings" (optional.Bool) - A boolean value to control whether input/output mappings should be executed during deletion. `true`, if input/output mappings should not be invoked.

func (*ProcessDefinitionApiService) GetActivityStatistics

GetActivityStatistics Get Activity Instance Statistics Retrieves runtime statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition.
  • @param optional nil or *GetActivityStatisticsOpts - Optional Parameters:
  • @param "FailedJobs" (optional.Bool) - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`.
  • @param "Incidents" (optional.Bool) - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`.
  • @param "IncidentsForType" (optional.String) - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types.

@return []ActivityStatisticsResultDto

func (*ProcessDefinitionApiService) GetActivityStatisticsByProcessDefinitionKey

func (a *ProcessDefinitionApiService) GetActivityStatisticsByProcessDefinitionKey(ctx _context.Context, key string, localVarOptionals *GetActivityStatisticsByProcessDefinitionKeyOpts) ([]ActivityStatisticsResultDto, *_nethttp.Response, error)

GetActivityStatisticsByProcessDefinitionKey Get Activity Instance Statistics Retrieves runtime statistics of the latest version of the given process definition which belongs to no tenant, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.
  • @param optional nil or *GetActivityStatisticsByProcessDefinitionKeyOpts - Optional Parameters:
  • @param "FailedJobs" (optional.Bool) - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`.
  • @param "Incidents" (optional.Bool) - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`.
  • @param "IncidentsForType" (optional.String) - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types.

@return []ActivityStatisticsResultDto

func (*ProcessDefinitionApiService) GetActivityStatisticsByProcessDefinitionKeyAndTenantId

func (a *ProcessDefinitionApiService) GetActivityStatisticsByProcessDefinitionKeyAndTenantId(ctx _context.Context, key string, tenantId string, localVarOptionals *GetActivityStatisticsByProcessDefinitionKeyAndTenantIdOpts) ([]ActivityStatisticsResultDto, *_nethttp.Response, error)

GetActivityStatisticsByProcessDefinitionKeyAndTenantId Get Activity Instance Statistics Retrieves runtime statistics of the latest version of the given process definition for a tenant, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.
  • @param tenantId The id of the tenant the process definition belongs to.
  • @param optional nil or *GetActivityStatisticsByProcessDefinitionKeyAndTenantIdOpts - Optional Parameters:
  • @param "FailedJobs" (optional.Bool) - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`.
  • @param "Incidents" (optional.Bool) - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`.
  • @param "IncidentsForType" (optional.String) - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types.

@return []ActivityStatisticsResultDto

func (*ProcessDefinitionApiService) GetDeployedStartForm

func (a *ProcessDefinitionApiService) GetDeployedStartForm(ctx _context.Context, id string) (*os.File, *_nethttp.Response, error)

GetDeployedStartForm Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to [User Guide](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#embedded-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition to get the deployed start form for.

@return *os.File

func (*ProcessDefinitionApiService) GetDeployedStartFormByKey

func (a *ProcessDefinitionApiService) GetDeployedStartFormByKey(ctx _context.Context, key string) (*os.File, *_nethttp.Response, error)

GetDeployedStartFormByKey Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to [User Guide](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#embedded-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.

@return *os.File

func (*ProcessDefinitionApiService) GetDeployedStartFormByKeyAndTenantId

func (a *ProcessDefinitionApiService) GetDeployedStartFormByKeyAndTenantId(ctx _context.Context, key string, tenantId string) (*os.File, *_nethttp.Response, error)

GetDeployedStartFormByKeyAndTenantId Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to [User Guide](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#embedded-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.
  • @param tenantId The id of the tenant the process definitions belong to.

@return *os.File

func (*ProcessDefinitionApiService) GetLatestProcessDefinitionByTenantId

func (a *ProcessDefinitionApiService) GetLatestProcessDefinitionByTenantId(ctx _context.Context, key string, tenantId string) (ProcessDefinitionDto, *_nethttp.Response, error)

GetLatestProcessDefinitionByTenantId Get Retrieves the latest version of the process definition for tenant according to the `ProcessDefinition` interface in the engine.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.
  • @param tenantId The id of the tenant the process definition belongs to.

@return ProcessDefinitionDto

func (*ProcessDefinitionApiService) GetProcessDefinition

GetProcessDefinition Get Retrieves a process definition according to the `ProcessDefinition` interface in the engine.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition to be retrieved.

@return ProcessDefinitionDto

func (*ProcessDefinitionApiService) GetProcessDefinitionBpmn20Xml

GetProcessDefinitionBpmn20Xml Get XML Retrieves the BPMN 2.0 XML of a process definition.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition.

@return ProcessDefinitionDiagramDto

func (*ProcessDefinitionApiService) GetProcessDefinitionBpmn20XmlByKey

func (a *ProcessDefinitionApiService) GetProcessDefinitionBpmn20XmlByKey(ctx _context.Context, key string) (ProcessDefinitionDiagramDto, *_nethttp.Response, error)

GetProcessDefinitionBpmn20XmlByKey Get XML Retrieves latest version the BPMN 2.0 XML of a process definition.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) whose XML should be retrieved.

@return ProcessDefinitionDiagramDto

func (*ProcessDefinitionApiService) GetProcessDefinitionBpmn20XmlByKeyAndTenantId

func (a *ProcessDefinitionApiService) GetProcessDefinitionBpmn20XmlByKeyAndTenantId(ctx _context.Context, key string, tenantId string) (ProcessDefinitionDiagramDto, *_nethttp.Response, error)

GetProcessDefinitionBpmn20XmlByKeyAndTenantId Get XML Retrieves latest version the BPMN 2.0 XML of a process definition. Returns the XML for the latest version of the process definition for tenant.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) whose XML should be retrieved.
  • @param tenantId The id of the tenant the process definition belongs to.

@return ProcessDefinitionDiagramDto

func (*ProcessDefinitionApiService) GetProcessDefinitionByKey

func (a *ProcessDefinitionApiService) GetProcessDefinitionByKey(ctx _context.Context, key string) (ProcessDefinitionDto, *_nethttp.Response, error)

GetProcessDefinitionByKey Get Retrieves the latest version of the process definition which belongs to no tenant according to the `ProcessDefinition` interface in the engine.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.

@return ProcessDefinitionDto

func (*ProcessDefinitionApiService) GetProcessDefinitionDiagram

func (a *ProcessDefinitionApiService) GetProcessDefinitionDiagram(ctx _context.Context, id string) (*os.File, *_nethttp.Response, error)

GetProcessDefinitionDiagram Get Diagram Retrieves the diagram of a process definition. If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: `someProcess.bpmn` and `someProcess.png`. Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition.

@return *os.File

func (*ProcessDefinitionApiService) GetProcessDefinitionDiagramByKey

func (a *ProcessDefinitionApiService) GetProcessDefinitionDiagramByKey(ctx _context.Context, key string) (*os.File, *_nethttp.Response, error)

GetProcessDefinitionDiagramByKey Get Diagram Retrieves the diagram for the latest version of the process definition which belongs to no tenant. If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: `someProcess.bpmn` and `someProcess.png`. Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition.

@return *os.File

func (*ProcessDefinitionApiService) GetProcessDefinitionDiagramByKeyAndTenantId

func (a *ProcessDefinitionApiService) GetProcessDefinitionDiagramByKeyAndTenantId(ctx _context.Context, key string, tenantId string) (*os.File, *_nethttp.Response, error)

GetProcessDefinitionDiagramByKeyAndTenantId Get Diagram Retrieves the diagram for the latest version of the process definition for tenant. If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: `someProcess.bpmn` and `someProcess.png`. Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition.
  • @param tenantId The id of the tenant the process definition belongs to.

@return *os.File

func (*ProcessDefinitionApiService) GetProcessDefinitionStatistics

GetProcessDefinitionStatistics Get Process Instance Statistics Retrieves runtime statistics of the process engine, grouped by process definitions. These statistics include the number of running process instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetProcessDefinitionStatisticsOpts - Optional Parameters:
  • @param "FailedJobs" (optional.Bool) - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`.
  • @param "Incidents" (optional.Bool) - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`.
  • @param "IncidentsForType" (optional.String) - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types.
  • @param "RootIncidents" (optional.Bool) - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of root incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType` or `incidents`.

@return []ProcessDefinitionStatisticsResultDto

func (*ProcessDefinitionApiService) GetProcessDefinitions

func (a *ProcessDefinitionApiService) GetProcessDefinitions(ctx _context.Context, localVarOptionals *GetProcessDefinitionsOpts) ([]ProcessDefinitionDto, *_nethttp.Response, error)

GetProcessDefinitions Get List Queries for process definitions that fulfill given parameters. Parameters may be the properties of process definitions, such as the name, key or version. The size of the result set can be retrieved by using the [Get Definition Count](https://docs.camunda.org/manual/7.13/reference/rest/process-definition/get-query-count/) method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetProcessDefinitionsOpts - Optional Parameters:
  • @param "ProcessDefinitionId" (optional.String) - Filter by process definition id.
  • @param "ProcessDefinitionIdIn" (optional.String) - Filter by a comma-separated list of process definition ids.
  • @param "Name" (optional.String) - Filter by process definition name.
  • @param "NameLike" (optional.String) - Filter by process definition names that the parameter is a substring of.
  • @param "DeploymentId" (optional.String) - Filter by the deployment the id belongs to.
  • @param "DeployedAfter" (optional.String) - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed after (exclusive) a specific time. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "DeployedAt" (optional.String) - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed at a specific time (exact match). By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "Key" (optional.String) - Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match.
  • @param "KeysIn" (optional.String) - Filter by a comma-separated list of process definition keys.
  • @param "KeyLike" (optional.String) - Filter by process definition keys that the parameter is a substring of.
  • @param "Category" (optional.String) - Filter by process definition category. Exact match.
  • @param "CategoryLike" (optional.String) - Filter by process definition categories that the parameter is a substring of.
  • @param "Version" (optional.Int32) - Filter by process definition version.
  • @param "LatestVersion" (optional.Bool) - Only include those process definitions that are latest versions. Value may only be `true`, as `false` is the default behavior.
  • @param "ResourceName" (optional.String) - Filter by the name of the process definition resource. Exact match.
  • @param "ResourceNameLike" (optional.String) - Filter by names of those process definition resources that the parameter is a substring of.
  • @param "StartableBy" (optional.String) - Filter by a user name who is allowed to start the process.
  • @param "Active" (optional.Bool) - Only include active process definitions. Value may only be `true`, as `false` is the default behavior.
  • @param "Suspended" (optional.Bool) - Only include suspended process definitions. Value may only be `true`, as `false` is the default behavior.
  • @param "IncidentId" (optional.String) - Filter by the incident id.
  • @param "IncidentType" (optional.String) - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types.
  • @param "IncidentMessage" (optional.String) - Filter by the incident message. Exact match.
  • @param "IncidentMessageLike" (optional.String) - Filter by the incident message that the parameter is a substring of.
  • @param "TenantIdIn" (optional.String) - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids.
  • @param "WithoutTenantId" (optional.Bool) - Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior.
  • @param "IncludeProcessDefinitionsWithoutTenantId" (optional.Bool) - Include process definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior.
  • @param "VersionTag" (optional.String) - Filter by the version tag.
  • @param "VersionTagLike" (optional.String) - Filter by the version tag that the parameter is a substring of.
  • @param "WithoutVersionTag" (optional.Bool) - Only include process definitions without a `versionTag`.
  • @param "StartableInTasklist" (optional.Bool) - Filter by process definitions which are startable in Tasklist..
  • @param "NotStartableInTasklist" (optional.Bool) - Filter by process definitions which are not startable in Tasklist.
  • @param "StartablePermissionCheck" (optional.Bool) - Filter by process definitions which the user is allowed to start in Tasklist. If the user doesn't have these permissions the result will be empty list. The permissions are: * `CREATE` permission for all Process instances * `CREATE_INSTANCE` and `READ` permission on Process definition level
  • @param "SortBy" (optional.String) - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
  • @param "SortOrder" (optional.String) - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

@return []ProcessDefinitionDto

func (*ProcessDefinitionApiService) GetProcessDefinitionsCount

func (a *ProcessDefinitionApiService) GetProcessDefinitionsCount(ctx _context.Context, localVarOptionals *GetProcessDefinitionsCountOpts) (CountResultDto, *_nethttp.Response, error)

GetProcessDefinitionsCount Get List Count Requests the number of process definitions that fulfill the query criteria. Takes the same filtering parameters as the [Get Definitions](https://docs.camunda.org/manual/7.13/reference/rest/process-definition/get-query/) method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetProcessDefinitionsCountOpts - Optional Parameters:
  • @param "ProcessDefinitionId" (optional.String) - Filter by process definition id.
  • @param "ProcessDefinitionIdIn" (optional.String) - Filter by a comma-separated list of process definition ids.
  • @param "Name" (optional.String) - Filter by process definition name.
  • @param "NameLike" (optional.String) - Filter by process definition names that the parameter is a substring of.
  • @param "DeploymentId" (optional.String) - Filter by the deployment the id belongs to.
  • @param "DeployedAfter" (optional.String) - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed after (exclusive) a specific time. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "DeployedAt" (optional.String) - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed at a specific time (exact match). By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "Key" (optional.String) - Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match.
  • @param "KeysIn" (optional.String) - Filter by a comma-separated list of process definition keys.
  • @param "KeyLike" (optional.String) - Filter by process definition keys that the parameter is a substring of.
  • @param "Category" (optional.String) - Filter by process definition category. Exact match.
  • @param "CategoryLike" (optional.String) - Filter by process definition categories that the parameter is a substring of.
  • @param "Version" (optional.Int32) - Filter by process definition version.
  • @param "LatestVersion" (optional.Bool) - Only include those process definitions that are latest versions. Value may only be `true`, as `false` is the default behavior.
  • @param "ResourceName" (optional.String) - Filter by the name of the process definition resource. Exact match.
  • @param "ResourceNameLike" (optional.String) - Filter by names of those process definition resources that the parameter is a substring of.
  • @param "StartableBy" (optional.String) - Filter by a user name who is allowed to start the process.
  • @param "Active" (optional.Bool) - Only include active process definitions. Value may only be `true`, as `false` is the default behavior.
  • @param "Suspended" (optional.Bool) - Only include suspended process definitions. Value may only be `true`, as `false` is the default behavior.
  • @param "IncidentId" (optional.String) - Filter by the incident id.
  • @param "IncidentType" (optional.String) - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types.
  • @param "IncidentMessage" (optional.String) - Filter by the incident message. Exact match.
  • @param "IncidentMessageLike" (optional.String) - Filter by the incident message that the parameter is a substring of.
  • @param "TenantIdIn" (optional.String) - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids.
  • @param "WithoutTenantId" (optional.Bool) - Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior.
  • @param "IncludeProcessDefinitionsWithoutTenantId" (optional.Bool) - Include process definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior.
  • @param "VersionTag" (optional.String) - Filter by the version tag.
  • @param "VersionTagLike" (optional.String) - Filter by the version tag that the parameter is a substring of.
  • @param "WithoutVersionTag" (optional.Bool) - Only include process definitions without a `versionTag`.
  • @param "StartableInTasklist" (optional.Bool) - Filter by process definitions which are startable in Tasklist..
  • @param "NotStartableInTasklist" (optional.Bool) - Filter by process definitions which are not startable in Tasklist.
  • @param "StartablePermissionCheck" (optional.Bool) - Filter by process definitions which the user is allowed to start in Tasklist. If the user doesn't have these permissions the result will be empty list. The permissions are: * `CREATE` permission for all Process instances * `CREATE_INSTANCE` and `READ` permission on Process definition level

@return CountResultDto

func (*ProcessDefinitionApiService) GetRenderedStartForm

func (a *ProcessDefinitionApiService) GetRenderedStartForm(ctx _context.Context, id string) (*os.File, *_nethttp.Response, error)

GetRenderedStartForm Get Rendered Start Form Retrieves the rendered form for a process definition. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#generated-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition to get the rendered start form for.

@return *os.File

func (*ProcessDefinitionApiService) GetRenderedStartFormByKey

func (a *ProcessDefinitionApiService) GetRenderedStartFormByKey(ctx _context.Context, key string) (*os.File, *_nethttp.Response, error)

GetRenderedStartFormByKey Get Rendered Start Form Retrieves the rendered form for the latest version of the process definition which belongs to no tenant. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#generated-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.

@return *os.File

func (*ProcessDefinitionApiService) GetRenderedStartFormByKeyAndTenantId

func (a *ProcessDefinitionApiService) GetRenderedStartFormByKeyAndTenantId(ctx _context.Context, key string, tenantId string) (*os.File, *_nethttp.Response, error)

GetRenderedStartFormByKeyAndTenantId Get Rendered Start Form Retrieves the rendered form for the latest version of the process definition for a tenant. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#generated-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.
  • @param tenantId The id of the tenant the process definition belongs to.

@return *os.File

func (*ProcessDefinitionApiService) GetStartForm

GetStartForm Get Start Form Key Retrieves the key of the start form for a process definition. The form key corresponds to the `FormData#formKey` property in the engine.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition to get the start form key for.

@return FormDto

func (*ProcessDefinitionApiService) GetStartFormByKey

func (a *ProcessDefinitionApiService) GetStartFormByKey(ctx _context.Context, key string) (FormDto, *_nethttp.Response, error)

GetStartFormByKey Get Start Form Key Retrieves the key of the start form for the latest version of the process definition which belongs to no tenant. The form key corresponds to the `FormData#formKey` property in the engine.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) for which the form key is to be retrieved.

@return FormDto

func (*ProcessDefinitionApiService) GetStartFormByKeyAndTenantId

func (a *ProcessDefinitionApiService) GetStartFormByKeyAndTenantId(ctx _context.Context, key string, tenantId string) (FormDto, *_nethttp.Response, error)

GetStartFormByKeyAndTenantId Get Start Form Key Retrieves the key of the start form for the latest version of the process definition for a tenant. The form key corresponds to the `FormData#formKey` property in the engine.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) for which the form key is to be retrieved.
  • @param tenantId The id of the tenant the process definition belongs to.

@return FormDto

func (*ProcessDefinitionApiService) GetStartFormVariables

func (a *ProcessDefinitionApiService) GetStartFormVariables(ctx _context.Context, id string, localVarOptionals *GetStartFormVariablesOpts) (map[string]VariableValueDto, *_nethttp.Response, error)

GetStartFormVariables Get Start Form Variables Retrieves the start form variables for a process definition (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#generated-task-forms) approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition to retrieve the variables for.
  • @param optional nil or *GetStartFormVariablesOpts - Optional Parameters:
  • @param "VariableNames" (optional.String) - A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored.
  • @param "DeserializeValues" (optional.Bool) - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](http://jackson.codehaus.org/) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note**: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine.

@return map[string]VariableValueDto

func (*ProcessDefinitionApiService) GetStartFormVariablesByKey

func (a *ProcessDefinitionApiService) GetStartFormVariablesByKey(ctx _context.Context, key string, localVarOptionals *GetStartFormVariablesByKeyOpts) (map[string]VariableValueDto, *_nethttp.Response, error)

GetStartFormVariablesByKey Get Start Form Variables Retrieves the start form variables for the latest process definition which belongs to no tenant (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#generated-task-forms) approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.
  • @param optional nil or *GetStartFormVariablesByKeyOpts - Optional Parameters:
  • @param "VariableNames" (optional.String) - A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored.
  • @param "DeserializeValues" (optional.Bool) - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](http://jackson.codehaus.org/) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note**: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine.

@return map[string]VariableValueDto

func (*ProcessDefinitionApiService) GetStartFormVariablesByKeyAndTenantId

func (a *ProcessDefinitionApiService) GetStartFormVariablesByKeyAndTenantId(ctx _context.Context, key string, tenantId string, localVarOptionals *GetStartFormVariablesByKeyAndTenantIdOpts) (map[string]VariableValueDto, *_nethttp.Response, error)

GetStartFormVariablesByKeyAndTenantId Get Start Form Variables Retrieves the start form variables for the latest process definition for a tenant (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#generated-task-forms) approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.
  • @param tenantId The id of the tenant the process definition belongs to.
  • @param optional nil or *GetStartFormVariablesByKeyAndTenantIdOpts - Optional Parameters:
  • @param "VariableNames" (optional.String) - A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored.
  • @param "DeserializeValues" (optional.Bool) - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](http://jackson.codehaus.org/) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note**: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine.

@return map[string]VariableValueDto

func (*ProcessDefinitionApiService) RestartProcessInstance

func (a *ProcessDefinitionApiService) RestartProcessInstance(ctx _context.Context, id string, localVarOptionals *RestartProcessInstanceOpts) (*_nethttp.Response, error)

RestartProcessInstance Restart Process Instance Restarts process instances that were canceled or terminated synchronously. Can also restart completed process instances. It will create a new instance using the original instance information. To execute the restart asynchronously, use the [Restart Process Instance Async](https://docs.camunda.org/manual/7.13/reference/rest/process-definition/post-restart-process-instance-async/) method. For more information about the difference between synchronous and asynchronous execution, please refer to the related section of the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/process-instance-restart/#execution).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition of the process instances to restart.
  • @param optional nil or *RestartProcessInstanceOpts - Optional Parameters:
  • @param "RestartProcessInstanceDto" (optional.Interface of RestartProcessInstanceDto) -

func (*ProcessDefinitionApiService) RestartProcessInstanceAsyncOperation

func (a *ProcessDefinitionApiService) RestartProcessInstanceAsyncOperation(ctx _context.Context, id string, localVarOptionals *RestartProcessInstanceAsyncOperationOpts) (BatchDto, *_nethttp.Response, error)

RestartProcessInstanceAsyncOperation Restart Process Instance Async Restarts process instances that were canceled or terminated asynchronously. Can also restart completed process instances. It will create a new instance using the original instance information. To execute the restart asynchronously, use the [Restart Process Instance](https://docs.camunda.org/manual/7.13/reference/rest/process-definition/post-restart-process-instance-sync/) method. For more information about the difference between synchronous and asynchronous execution, please refer to the related section of the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/process-instance-restart/#execution).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition of the process instances to restart.
  • @param optional nil or *RestartProcessInstanceAsyncOperationOpts - Optional Parameters:
  • @param "RestartProcessInstanceDto" (optional.Interface of RestartProcessInstanceDto) -

@return BatchDto

func (*ProcessDefinitionApiService) StartProcessInstance

StartProcessInstance Start Instance Instantiates a given process definition. Process variables and business key may be supplied in the request body.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition to be retrieved.
  • @param optional nil or *StartProcessInstanceOpts - Optional Parameters:
  • @param "StartProcessInstanceDto" (optional.Interface of StartProcessInstanceDto) -

@return ProcessInstanceWithVariablesDto

func (*ProcessDefinitionApiService) StartProcessInstanceByKey

StartProcessInstanceByKey Start Instance Instantiates a given process definition, starts the latest version of the process definition which belongs to no tenant. Process variables and business key may be supplied in the request body.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.
  • @param optional nil or *StartProcessInstanceByKeyOpts - Optional Parameters:
  • @param "StartProcessInstanceDto" (optional.Interface of StartProcessInstanceDto) -

@return ProcessInstanceWithVariablesDto

func (*ProcessDefinitionApiService) StartProcessInstanceByKeyAndTenantId

func (a *ProcessDefinitionApiService) StartProcessInstanceByKeyAndTenantId(ctx _context.Context, key string, tenantId string, localVarOptionals *StartProcessInstanceByKeyAndTenantIdOpts) (ProcessInstanceWithVariablesDto, *_nethttp.Response, error)

StartProcessInstanceByKeyAndTenantId Start Instance Instantiates a given process definition, starts the latest version of the process definition for tenant. Process variables and business key may be supplied in the request body.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be retrieved.
  • @param tenantId The id of the tenant the process definition belongs to.
  • @param optional nil or *StartProcessInstanceByKeyAndTenantIdOpts - Optional Parameters:
  • @param "StartProcessInstanceDto" (optional.Interface of StartProcessInstanceDto) -

@return ProcessInstanceWithVariablesDto

func (*ProcessDefinitionApiService) SubmitForm

SubmitForm Submit Start Form Starts a process instance using a set of process variables and the business key. If the start event has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See [Documentation on Generated Task Forms](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#generated-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition to submit the form for.
  • @param optional nil or *SubmitFormOpts - Optional Parameters:
  • @param "StartProcessInstanceFormDto" (optional.Interface of StartProcessInstanceFormDto) -

@return ProcessInstanceDto

func (*ProcessDefinitionApiService) SubmitFormByKey

func (a *ProcessDefinitionApiService) SubmitFormByKey(ctx _context.Context, key string, localVarOptionals *SubmitFormByKeyOpts) (ProcessInstanceDto, *_nethttp.Response, error)

SubmitFormByKey Submit Start Form Starts the latest version of the process definition which belongs to no tenant using a set of process variables and the business key. If the start event has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See [Documentation on Generated Task Forms](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#generated-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition to submit the form for.
  • @param optional nil or *SubmitFormByKeyOpts - Optional Parameters:
  • @param "StartProcessInstanceFormDto" (optional.Interface of StartProcessInstanceFormDto) -

@return ProcessInstanceDto

func (*ProcessDefinitionApiService) SubmitFormByKeyAndTenantId

func (a *ProcessDefinitionApiService) SubmitFormByKeyAndTenantId(ctx _context.Context, key string, tenantId string, localVarOptionals *SubmitFormByKeyAndTenantIdOpts) (ProcessInstanceDto, *_nethttp.Response, error)

SubmitFormByKeyAndTenantId Submit Start Form Starts the latest version of the process definition for a tenant using a set of process variables and the business key. If the start event has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See [Documentation on Generated Task Forms](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#generated-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition to submit the form for.
  • @param tenantId The id of the tenant the process definition belongs to.
  • @param optional nil or *SubmitFormByKeyAndTenantIdOpts - Optional Parameters:
  • @param "StartProcessInstanceFormDto" (optional.Interface of StartProcessInstanceFormDto) -

@return ProcessInstanceDto

func (*ProcessDefinitionApiService) UpdateHistoryTimeToLiveByProcessDefinitionId

func (a *ProcessDefinitionApiService) UpdateHistoryTimeToLiveByProcessDefinitionId(ctx _context.Context, id string, localVarOptionals *UpdateHistoryTimeToLiveByProcessDefinitionIdOpts) (*_nethttp.Response, error)

UpdateHistoryTimeToLiveByProcessDefinitionId Update History Time to Live Updates history time to live for process definition. The field is used within [History cleanup](https://docs.camunda.org/manual/7.13/user-guide/process-engine/history/#history-cleanup).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition to change history time to live.
  • @param optional nil or *UpdateHistoryTimeToLiveByProcessDefinitionIdOpts - Optional Parameters:
  • @param "HistoryTimeToLiveDto" (optional.Interface of HistoryTimeToLiveDto) -

func (*ProcessDefinitionApiService) UpdateHistoryTimeToLiveByProcessDefinitionKey

func (a *ProcessDefinitionApiService) UpdateHistoryTimeToLiveByProcessDefinitionKey(ctx _context.Context, key string, localVarOptionals *UpdateHistoryTimeToLiveByProcessDefinitionKeyOpts) (*_nethttp.Response, error)

UpdateHistoryTimeToLiveByProcessDefinitionKey Update History Time to Live Updates history time to live for the latest version of the process definition which belongs to no tenant. The field is used within [History cleanup](https://docs.camunda.org/manual/7.13/user-guide/process-engine/history/#history-cleanup).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition to change history time to live.
  • @param optional nil or *UpdateHistoryTimeToLiveByProcessDefinitionKeyOpts - Optional Parameters:
  • @param "HistoryTimeToLiveDto" (optional.Interface of HistoryTimeToLiveDto) -

func (*ProcessDefinitionApiService) UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId

func (a *ProcessDefinitionApiService) UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId(ctx _context.Context, key string, tenantId string, localVarOptionals *UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdOpts) (*_nethttp.Response, error)

UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId Update History Time to Live Updates history time to live for the latest version of the process definition for a tenant. The field is used within [History cleanup](https://docs.camunda.org/manual/7.13/user-guide/process-engine/history/#history-cleanup).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition to change history time to live.
  • @param tenantId The id of the tenant the process definition belongs to.
  • @param optional nil or *UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdOpts - Optional Parameters:
  • @param "HistoryTimeToLiveDto" (optional.Interface of HistoryTimeToLiveDto) -

func (*ProcessDefinitionApiService) UpdateProcessDefinitionSuspensionState

func (a *ProcessDefinitionApiService) UpdateProcessDefinitionSuspensionState(ctx _context.Context, localVarOptionals *UpdateProcessDefinitionSuspensionStateOpts) (*_nethttp.Response, error)

UpdateProcessDefinitionSuspensionState Activate/Suspend By Key Activates or suspends process definitions with the given process definition key.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *UpdateProcessDefinitionSuspensionStateOpts - Optional Parameters:
  • @param "ProcessDefinitionSuspensionStateDto" (optional.Interface of ProcessDefinitionSuspensionStateDto) - **Note**: Unallowed property is `processDefinitionId`.

func (*ProcessDefinitionApiService) UpdateProcessDefinitionSuspensionStateById

func (a *ProcessDefinitionApiService) UpdateProcessDefinitionSuspensionStateById(ctx _context.Context, id string, localVarOptionals *UpdateProcessDefinitionSuspensionStateByIdOpts) (*_nethttp.Response, error)

UpdateProcessDefinitionSuspensionStateById Activate/Suspend By Id Activates or suspends a given process definition by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process definition to activate or suspend.
  • @param optional nil or *UpdateProcessDefinitionSuspensionStateByIdOpts - Optional Parameters:
  • @param "ProcessDefinitionSuspensionStateDto" (optional.Interface of ProcessDefinitionSuspensionStateDto) - **Note**: Unallowed properties are `processDefinitionId` and `processDefinitionKey`.

func (*ProcessDefinitionApiService) UpdateProcessDefinitionSuspensionStateByKey

func (a *ProcessDefinitionApiService) UpdateProcessDefinitionSuspensionStateByKey(ctx _context.Context, key string, localVarOptionals *UpdateProcessDefinitionSuspensionStateByKeyOpts) (*_nethttp.Response, error)

UpdateProcessDefinitionSuspensionStateByKey Activate/Suspend by Id Activates or suspends a given process definition by latest version of process definition key which belongs to no tenant.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be activated/suspended.
  • @param optional nil or *UpdateProcessDefinitionSuspensionStateByKeyOpts - Optional Parameters:
  • @param "ProcessDefinitionSuspensionStateDto" (optional.Interface of ProcessDefinitionSuspensionStateDto) - **Note**: Unallowed properties are `processDefinitionId` and `processDefinitionKey`.

func (*ProcessDefinitionApiService) UpdateProcessDefinitionSuspensionStateByKeyAndTenantId

func (a *ProcessDefinitionApiService) UpdateProcessDefinitionSuspensionStateByKeyAndTenantId(ctx _context.Context, key string, tenantId string, localVarOptionals *UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdOpts) (*_nethttp.Response, error)

UpdateProcessDefinitionSuspensionStateByKeyAndTenantId Activate/Suspend by Id Activates or suspends a given process definition by the latest version of the process definition for tenant.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key The key of the process definition (the latest version thereof) to be activated/suspended.
  • @param tenantId The id of the tenant the process definition belongs to.
  • @param optional nil or *UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdOpts - Optional Parameters:
  • @param "ProcessDefinitionSuspensionStateDto" (optional.Interface of ProcessDefinitionSuspensionStateDto) - **Note**: Unallowed properties are `processDefinitionId` and `processDefinitionKey`.

type ProcessDefinitionDiagramDto

type ProcessDefinitionDiagramDto struct {
	// The id of the process definition.
	Id string `json:"id,omitempty"`
	// An escaped XML string containing the XML that this definition was deployed with. Carriage returns, line feeds and quotation marks are escaped.
	Bpmn20Xml string `json:"bpmn20Xml,omitempty"`
}

ProcessDefinitionDiagramDto struct for ProcessDefinitionDiagramDto

type ProcessDefinitionDto

type ProcessDefinitionDto struct {
	// The id of the process definition
	Id string `json:"id,omitempty"`
	// The key of the process definition, i.e., the id of the BPMN 2.0 XML process definition.
	Key string `json:"key,omitempty"`
	// The category of the process definition.
	Category string `json:"category,omitempty"`
	// The description of the process definition.
	Description string `json:"description,omitempty"`
	// The name of the process definition.
	Name string `json:"name,omitempty"`
	// The version of the process definition that the engine assigned to it.
	Version int32 `json:"version,omitempty"`
	// The file name of the process definition.
	Resource string `json:"resource,omitempty"`
	// The deployment id of the process definition.
	DeploymentId string `json:"deploymentId,omitempty"`
	// The file name of the process definition diagram, if it exists.
	Diagram string `json:"diagram,omitempty"`
	// A flag indicating whether the definition is suspended or not.
	Suspended bool `json:"suspended,omitempty"`
	// The tenant id of the process definition.
	TenantId string `json:"tenantId,omitempty"`
	// The version tag of the process definition.
	VersionTag string `json:"versionTag,omitempty"`
	// History time to live value of the process definition. Is used within [History cleanup](https://docs.camunda.org/manual/7.13/user-guide/process-engine/history/#history-cleanup).
	HistoryTimeToLive *int32 `json:"historyTimeToLive,omitempty"`
	// A flag indicating whether the process definition is startable in Tasklist or not.
	StartableInTasklist bool `json:"startableInTasklist,omitempty"`
}

ProcessDefinitionDto struct for ProcessDefinitionDto

type ProcessDefinitionStatisticsResultDto

type ProcessDefinitionStatisticsResultDto struct {
	// The id of the process definition the results are aggregated for.
	Id string `json:"id,omitempty"`
	// The total number of running process instances of this process definition.
	Instances int32 `json:"instances,omitempty"`
	// The total number of failed jobs for the running instances. **Note**: Will be `0` (not `null`), if failed jobs were excluded.
	FailedJobs int32 `json:"failedJobs,omitempty"`
	// Each item in the resulting array is an object which contains `incidentType` and `incidentCount`. **Note**: Will be an empty array, if `incidents` or `incidentsForType` were excluded. Furthermore, the array will be also empty if no incidents were found.
	Incidents  []IncidentStatisticsResultDto `json:"incidents,omitempty"`
	Definition ProcessDefinitionDto          `json:"definition,omitempty"`
}

ProcessDefinitionStatisticsResultDto struct for ProcessDefinitionStatisticsResultDto

type ProcessDefinitionSuspensionStateDto

type ProcessDefinitionSuspensionStateDto struct {
	// A `Boolean` value which indicates whether to activate or suspend all process definitions with the given key. When the value is set to `true`, all process definitions with the given key will be suspended and when the value is set to `false`, all process definitions with the given key will be activated.
	Suspended *bool `json:"suspended,omitempty"`
	// The id of the process definitions to activate or suspend.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	//  The key of the process definitions to activate or suspend.
	ProcessDefinitionKey string `json:"processDefinitionKey,omitempty"`
	// A `Boolean` value which indicates whether to activate or suspend also all process instances of  the process definitions with the given key. When the value is set to `true`, all process instances of the process definitions with the given key will be activated or suspended and when the value is set to `false`, the suspension state of  all process instances of the process definitions with the given key will not be updated.
	IncludeProcessInstances *bool `json:"includeProcessInstances,omitempty"`
	// The date on which all process definitions with the given key will be activated or suspended. If `null`, the suspension state of all process definitions with the given key is updated immediately. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format yyyy-MM-dd' 'HH:mm:ss, e.g., 2013-01-23 14:42:45.
	ExecutionDate *string `json:"executionDate,omitempty"`
}

ProcessDefinitionSuspensionStateDto struct for ProcessDefinitionSuspensionStateDto

type ProcessEngineDto

type ProcessEngineDto struct {
	// The name of the process engine.
	Name string `json:"name,omitempty"`
}

ProcessEngineDto struct for ProcessEngineDto

type ProcessInstanceApiService

type ProcessInstanceApiService service

ProcessInstanceApiService ProcessInstanceApi service

func (*ProcessInstanceApiService) DeleteAsyncHistoricQueryBased

func (a *ProcessInstanceApiService) DeleteAsyncHistoricQueryBased(ctx _context.Context, localVarOptionals *DeleteAsyncHistoricQueryBasedOpts) (BatchDto, *_nethttp.Response, error)

DeleteAsyncHistoricQueryBased Method for DeleteAsyncHistoricQueryBased Deletes a set of process instances asynchronously (batch) based on a historic process instance query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DeleteAsyncHistoricQueryBasedOpts - Optional Parameters:
  • @param "DeleteProcessInstancesDto" (optional.Interface of DeleteProcessInstancesDto) - **Unallowed property**: `processInstanceQuery`

@return BatchDto

func (*ProcessInstanceApiService) DeleteProcessInstance

func (a *ProcessInstanceApiService) DeleteProcessInstance(ctx _context.Context, id string, localVarOptionals *DeleteProcessInstanceOpts) (*_nethttp.Response, error)

DeleteProcessInstance Method for DeleteProcessInstance Deletes a running process instance by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to be deleted.
  • @param optional nil or *DeleteProcessInstanceOpts - Optional Parameters:
  • @param "SkipCustomListeners" (optional.Bool) - If set to true, the custom listeners will be skipped.
  • @param "SkipIoMappings" (optional.Bool) - If set to true, the input/output mappings will be skipped.
  • @param "SkipSubprocesses" (optional.Bool) - If set to true, subprocesses related to deleted processes will be skipped.
  • @param "FailIfNotExists" (optional.Bool) - If set to false, the request will still be successful if the process id is not found.

func (*ProcessInstanceApiService) DeleteProcessInstanceVariable

func (a *ProcessInstanceApiService) DeleteProcessInstanceVariable(ctx _context.Context, id string, varName string) (*_nethttp.Response, error)

DeleteProcessInstanceVariable Method for DeleteProcessInstanceVariable Deletes a variable of a process instance by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to delete the variable from.
  • @param varName The name of the variable to delete.

func (*ProcessInstanceApiService) DeleteProcessInstancesAsyncOperation

func (a *ProcessInstanceApiService) DeleteProcessInstancesAsyncOperation(ctx _context.Context, localVarOptionals *DeleteProcessInstancesAsyncOperationOpts) (BatchDto, *_nethttp.Response, error)

DeleteProcessInstancesAsyncOperation Method for DeleteProcessInstancesAsyncOperation Deletes multiple process instances asynchronously (batch).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DeleteProcessInstancesAsyncOperationOpts - Optional Parameters:
  • @param "DeleteProcessInstancesDto" (optional.Interface of DeleteProcessInstancesDto) - **Unallowed property**: `historicProcessInstanceQuery`

@return BatchDto

func (*ProcessInstanceApiService) GetActivityInstanceTree

GetActivityInstanceTree Method for GetActivityInstanceTree Retrieves an Activity Instance (Tree) for a given process instance by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance for which the activity instance should be retrieved.

@return ActivityInstanceDto

func (*ProcessInstanceApiService) GetProcessInstanceVariable

func (a *ProcessInstanceApiService) GetProcessInstanceVariable(ctx _context.Context, id string, varName string, localVarOptionals *GetProcessInstanceVariableOpts) (VariableValueDto, *_nethttp.Response, error)

GetProcessInstanceVariable Method for GetProcessInstanceVariable Retrieves a variable of a given process instance by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to retrieve the variable for.
  • @param varName The name of the variable to retrieve.
  • @param optional nil or *GetProcessInstanceVariableOpts - Optional Parameters:
  • @param "DeserializeValue" (optional.Bool) - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine.

@return VariableValueDto

func (*ProcessInstanceApiService) GetProcessInstanceVariableBinary

func (a *ProcessInstanceApiService) GetProcessInstanceVariableBinary(ctx _context.Context, id string, varName string) (*os.File, *_nethttp.Response, error)

GetProcessInstanceVariableBinary Method for GetProcessInstanceVariableBinary Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name. Applicable for byte array or file Process Variables.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to retrieve the variable for.
  • @param varName The name of the variable to retrieve.

@return *os.File

func (*ProcessInstanceApiService) GetProcessInstanceVariables

func (a *ProcessInstanceApiService) GetProcessInstanceVariables(ctx _context.Context, id string, localVarOptionals *GetProcessInstanceVariablesOpts) (map[string]VariableValueDto, *_nethttp.Response, error)

GetProcessInstanceVariables Method for GetProcessInstanceVariables Retrieves all variables of a given process instance by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to retrieve the variables from.
  • @param optional nil or *GetProcessInstanceVariablesOpts - Optional Parameters:
  • @param "DeserializeValue" (optional.Bool) - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine.

@return map[string]VariableValueDto

func (*ProcessInstanceApiService) GetProcessInstances

func (a *ProcessInstanceApiService) GetProcessInstances(ctx _context.Context, localVarOptionals *GetProcessInstancesOpts) ([]ProcessInstanceDto, *_nethttp.Response, error)

GetProcessInstances Method for GetProcessInstances Queries for process instances that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of process instances. The size of the result set can be retrieved by using the Get Instance Count method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetProcessInstancesOpts - Optional Parameters:
  • @param "SortBy" (optional.String) - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
  • @param "SortOrder" (optional.String) - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
  • @param "ProcessInstanceIds" (optional.String) - Filter by a comma-separated list of process instance ids.
  • @param "BusinessKey" (optional.String) - Filter by process instance business key.
  • @param "BusinessKeyLike" (optional.String) - Filter by process instance business key that the parameter is a substring of.
  • @param "CaseInstanceId" (optional.String) - Filter by case instance id.
  • @param "ProcessDefinitionId" (optional.String) - Filter by the deployment the id belongs to.
  • @param "ProcessDefinitionKey" (optional.String) - Filter by the key of the process definition the instances run on.
  • @param "ProcessDefinitionKeyIn" (optional.String) - Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys.
  • @param "ProcessDefinitionKeyNotIn" (optional.String) - Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys.
  • @param "DeploymentId" (optional.String) - Filter by the deployment the id belongs to.
  • @param "SuperProcessInstance" (optional.String) - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id.
  • @param "SubProcessInstance" (optional.String) - Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id.
  • @param "SuperCaseInstance" (optional.String) - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
  • @param "SubCaseInstance" (optional.String) - Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id.
  • @param "Active" (optional.Bool) - Only include active process instances. Value may only be true, as false is the default behavior.
  • @param "Suspended" (optional.Bool) - Only include suspended process instances. Value may only be true, as false is the default behavior.
  • @param "WithIncident" (optional.Bool) - Filter by presence of incidents. Selects only process instances that have an incident.
  • @param "IncidentId" (optional.String) - Filter by the incident id.
  • @param "IncidentType" (optional.String) - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types.
  • @param "IncidentMessage" (optional.String) - Filter by the incident message. Exact match.
  • @param "IncidentMessageLike" (optional.String) - Filter by the incident message that the parameter is a substring of.
  • @param "TenantIdIn" (optional.String) - Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids.
  • @param "WithoutTenantId" (optional.Bool) - Only include process instances which belong to no tenant.
  • @param "ProcessDefinitionWithoutTenantId" (optional.Bool) - Only include process instances which process definition has no tenant id.
  • @param "ActivityIdIn" (optional.String) - Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids.
  • @param "RootProcessInstances" (optional.Bool) - Restrict the query to all process instances that are top level process instances.
  • @param "LeafProcessInstances" (optional.Bool) - Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances).
  • @param "Variables" (optional.String) - Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
  • @param "VariableNamesIgnoreCase" (optional.Bool) - Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal.
  • @param "VariableValuesIgnoreCase" (optional.Bool) - Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal.

@return []ProcessInstanceDto

func (*ProcessInstanceApiService) GetProcessInstancesCount

func (a *ProcessInstanceApiService) GetProcessInstancesCount(ctx _context.Context, localVarOptionals *GetProcessInstancesCountOpts) (CountResultDto, *_nethttp.Response, error)

GetProcessInstancesCount Method for GetProcessInstancesCount Queries for the number of process instances that fulfill given parameters.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetProcessInstancesCountOpts - Optional Parameters:
  • @param "ProcessInstanceIds" (optional.String) - Filter by a comma-separated list of process instance ids.
  • @param "BusinessKey" (optional.String) - Filter by process instance business key.
  • @param "BusinessKeyLike" (optional.String) - Filter by process instance business key that the parameter is a substring of.
  • @param "CaseInstanceId" (optional.String) - Filter by case instance id.
  • @param "ProcessDefinitionId" (optional.String) - Filter by the deployment the id belongs to.
  • @param "ProcessDefinitionKey" (optional.String) - Filter by the key of the process definition the instances run on.
  • @param "ProcessDefinitionKeyIn" (optional.String) - Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys.
  • @param "ProcessDefinitionKeyNotIn" (optional.String) - Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys.
  • @param "DeploymentId" (optional.String) - Filter by the deployment the id belongs to.
  • @param "SuperProcessInstance" (optional.String) - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id.
  • @param "SubProcessInstance" (optional.String) - Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id.
  • @param "SuperCaseInstance" (optional.String) - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
  • @param "SubCaseInstance" (optional.String) - Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id.
  • @param "Active" (optional.Bool) - Only include active process instances. Value may only be true, as false is the default behavior.
  • @param "Suspended" (optional.Bool) - Only include suspended process instances. Value may only be true, as false is the default behavior.
  • @param "WithIncident" (optional.Bool) - Filter by presence of incidents. Selects only process instances that have an incident.
  • @param "IncidentId" (optional.String) - Filter by the incident id.
  • @param "IncidentType" (optional.String) - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types.
  • @param "IncidentMessage" (optional.String) - Filter by the incident message. Exact match.
  • @param "IncidentMessageLike" (optional.String) - Filter by the incident message that the parameter is a substring of.
  • @param "TenantIdIn" (optional.String) - Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids.
  • @param "WithoutTenantId" (optional.Bool) - Only include process instances which belong to no tenant.
  • @param "ProcessDefinitionWithoutTenantId" (optional.Bool) - Only include process instances which process definition has no tenant id.
  • @param "ActivityIdIn" (optional.String) - Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids.
  • @param "RootProcessInstances" (optional.Bool) - Restrict the query to all process instances that are top level process instances.
  • @param "LeafProcessInstances" (optional.Bool) - Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances).
  • @param "Variables" (optional.String) - Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
  • @param "VariableNamesIgnoreCase" (optional.Bool) - Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal.
  • @param "VariableValuesIgnoreCase" (optional.Bool) - Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal.

@return CountResultDto

func (*ProcessInstanceApiService) ModifyProcessInstance

func (a *ProcessInstanceApiService) ModifyProcessInstance(ctx _context.Context, id string, localVarOptionals *ModifyProcessInstanceOpts) (*_nethttp.Response, error)

ModifyProcessInstance Method for ModifyProcessInstance Submits a list of modification instructions to change a process instance's execution state. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Canceling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed immediately and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/process-instance-modification/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to modify.
  • @param optional nil or *ModifyProcessInstanceOpts - Optional Parameters:
  • @param "ProcessInstanceModificationDto" (optional.Interface of ProcessInstanceModificationDto) -

func (*ProcessInstanceApiService) ModifyProcessInstanceAsyncOperation

func (a *ProcessInstanceApiService) ModifyProcessInstanceAsyncOperation(ctx _context.Context, id string, localVarOptionals *ModifyProcessInstanceAsyncOperationOpts) (BatchDto, *_nethttp.Response, error)

ModifyProcessInstanceAsyncOperation Method for ModifyProcessInstanceAsyncOperation Submits a list of modification instructions to change a process instance's execution state async. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Cancelling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed asynchronous and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/process-instance-modification/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to modify.
  • @param optional nil or *ModifyProcessInstanceAsyncOperationOpts - Optional Parameters:
  • @param "ProcessInstanceModificationDto" (optional.Interface of ProcessInstanceModificationDto) -

@return BatchDto

func (*ProcessInstanceApiService) ModifyProcessInstanceVariables

func (a *ProcessInstanceApiService) ModifyProcessInstanceVariables(ctx _context.Context, id string, localVarOptionals *ModifyProcessInstanceVariablesOpts) (*_nethttp.Response, error)

ModifyProcessInstanceVariables Method for ModifyProcessInstanceVariables Updates or deletes the variables of a process instance by id. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to set variables for.
  • @param optional nil or *ModifyProcessInstanceVariablesOpts - Optional Parameters:
  • @param "PatchVariablesDto" (optional.Interface of PatchVariablesDto) -

func (*ProcessInstanceApiService) QueryProcessInstances

func (a *ProcessInstanceApiService) QueryProcessInstances(ctx _context.Context, localVarOptionals *QueryProcessInstancesOpts) ([]ProcessInstanceDto, *_nethttp.Response, error)

QueryProcessInstances Method for QueryProcessInstances Queries for process instances that fulfill given parameters through a JSON object. This method is slightly more powerful than the Get Instances method because it allows filtering by multiple process variables of types `string`, `number` or `boolean`.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *QueryProcessInstancesOpts - Optional Parameters:
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
  • @param "ProcessInstanceQueryDto" (optional.Interface of ProcessInstanceQueryDto) -

@return []ProcessInstanceDto

func (*ProcessInstanceApiService) QueryProcessInstancesCount

func (a *ProcessInstanceApiService) QueryProcessInstancesCount(ctx _context.Context, localVarOptionals *QueryProcessInstancesCountOpts) (CountResultDto, *_nethttp.Response, error)

QueryProcessInstancesCount Method for QueryProcessInstancesCount Queries for the number of process instances that fulfill the given parameters. This method takes the same message body as the Get Instances (POST) method and therefore it is slightly more powerful than the Get Instance Count method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *QueryProcessInstancesCountOpts - Optional Parameters:
  • @param "ProcessInstanceQueryDto" (optional.Interface of ProcessInstanceQueryDto) -

@return CountResultDto

func (*ProcessInstanceApiService) SetProcessInstanceVariable

func (a *ProcessInstanceApiService) SetProcessInstanceVariable(ctx _context.Context, id string, varName string, localVarOptionals *SetProcessInstanceVariableOpts) (*_nethttp.Response, error)

SetProcessInstanceVariable Method for SetProcessInstanceVariable Sets a variable of a given process instance by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to set the variable for.
  • @param varName The name of the variable to set.
  • @param optional nil or *SetProcessInstanceVariableOpts - Optional Parameters:
  • @param "VariableValueDto" (optional.Interface of VariableValueDto) -

func (*ProcessInstanceApiService) SetProcessInstanceVariableBinary

func (a *ProcessInstanceApiService) SetProcessInstanceVariableBinary(ctx _context.Context, id string, varName string, localVarOptionals *SetProcessInstanceVariableBinaryOpts) (*_nethttp.Response, error)

SetProcessInstanceVariableBinary Method for SetProcessInstanceVariableBinary Sets the serialized value for a binary variable or the binary value for a file variable.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to retrieve the variable for.
  • @param varName The name of the variable to retrieve.
  • @param optional nil or *SetProcessInstanceVariableBinaryOpts - Optional Parameters:
  • @param "Data" (optional.Interface of *os.File) - The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory.
  • @param "ValueType" (optional.String) - The name of the variable type. Either Bytes for a byte array variable or File for a file variable.

func (*ProcessInstanceApiService) SetRetriesByProcess

func (a *ProcessInstanceApiService) SetRetriesByProcess(ctx _context.Context, localVarOptionals *SetRetriesByProcessOpts) (BatchDto, *_nethttp.Response, error)

SetRetriesByProcess Method for SetRetriesByProcess Create a batch to set retries of jobs associated with given processes asynchronously.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SetRetriesByProcessOpts - Optional Parameters:
  • @param "SetJobRetriesByProcessDto" (optional.Interface of SetJobRetriesByProcessDto) - Please note that if both processInstances and processInstanceQuery are provided, then the resulting execution will be performed on the union of these sets. **Unallowed property**: `historicProcessInstanceQuery`

@return BatchDto

func (*ProcessInstanceApiService) SetRetriesByProcessHistoricQueryBased

func (a *ProcessInstanceApiService) SetRetriesByProcessHistoricQueryBased(ctx _context.Context, localVarOptionals *SetRetriesByProcessHistoricQueryBasedOpts) (BatchDto, *_nethttp.Response, error)

SetRetriesByProcessHistoricQueryBased Method for SetRetriesByProcessHistoricQueryBased Create a batch to set retries of jobs asynchronously based on a historic process instance query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SetRetriesByProcessHistoricQueryBasedOpts - Optional Parameters:
  • @param "SetJobRetriesByProcessDto" (optional.Interface of SetJobRetriesByProcessDto) - Please note that if both processInstances and historicProcessInstanceQuery are provided, then the resulting execution will be performed on the union of these sets. **Unallowed property**: `processInstanceQuery`

@return BatchDto

func (*ProcessInstanceApiService) UpdateSuspensionState

func (a *ProcessInstanceApiService) UpdateSuspensionState(ctx _context.Context, localVarOptionals *UpdateSuspensionStateOpts) (*_nethttp.Response, error)

UpdateSuspensionState Method for UpdateSuspensionState Activates or suspends process instances by providing certain criteria: # Activate/Suspend Process Instance By Process Definition Id * `suspend` * `processDefinitionId` # Activate/Suspend Process Instance By Process Definition Key * `suspend` * `processDefinitionKey` * `processDefinitionTenantId` * `processDefinitionWithoutTenantId` # Activate/Suspend Process Instance In Group * `suspend` * `processInstanceIds` * `processInstanceQuery` * `historicProcessInstanceQuery`

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *UpdateSuspensionStateOpts - Optional Parameters:
  • @param "ProcessInstanceSuspensionStateDto" (optional.Interface of ProcessInstanceSuspensionStateDto) -

func (*ProcessInstanceApiService) UpdateSuspensionStateAsyncOperation

func (a *ProcessInstanceApiService) UpdateSuspensionStateAsyncOperation(ctx _context.Context, localVarOptionals *UpdateSuspensionStateAsyncOperationOpts) (BatchDto, *_nethttp.Response, error)

UpdateSuspensionStateAsyncOperation Method for UpdateSuspensionStateAsyncOperation Activates or suspends process instances asynchronously with a list of process instance ids, a process instance query, and/or a historical process instance query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *UpdateSuspensionStateAsyncOperationOpts - Optional Parameters:
  • @param "ProcessInstanceSuspensionStateAsyncDto" (optional.Interface of ProcessInstanceSuspensionStateAsyncDto) -

@return BatchDto

func (*ProcessInstanceApiService) UpdateSuspensionStateById

func (a *ProcessInstanceApiService) UpdateSuspensionStateById(ctx _context.Context, id string, localVarOptionals *UpdateSuspensionStateByIdOpts) (*_nethttp.Response, error)

UpdateSuspensionStateById Method for UpdateSuspensionStateById Activates or suspends a given process instance by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the process instance to activate or suspend.
  • @param optional nil or *UpdateSuspensionStateByIdOpts - Optional Parameters:
  • @param "SuspensionStateDto" (optional.Interface of SuspensionStateDto) -

type ProcessInstanceDto

type ProcessInstanceDto struct {
	// The id of the process instance.
	Id string `json:"id,omitempty"`
	// The id of the process definition that this process instance belongs to.
	DefinitionId string `json:"definitionId,omitempty"`
	// The business key of the process instance.
	BusinessKey string `json:"businessKey,omitempty"`
	// The id of the case instance associated with the process instance.
	CaseInstanceId string `json:"caseInstanceId,omitempty"`
	// A flag indicating whether the process instance has ended or not. Deprecated: will always be false!
	Ended bool `json:"ended,omitempty"`
	// A flag indicating whether the process instance is suspended or not.
	Suspended bool `json:"suspended,omitempty"`
	// The tenant id of the process instance.
	TenantId string `json:"tenantId,omitempty"`
	// The links associated to this resource, with `method`, `href` and `rel`.
	Links []AtomLink `json:"links,omitempty"`
}

ProcessInstanceDto struct for ProcessInstanceDto

type ProcessInstanceDtoAllOf

type ProcessInstanceDtoAllOf struct {
	// The id of the process instance.
	Id string `json:"id,omitempty"`
	// The id of the process definition that this process instance belongs to.
	DefinitionId string `json:"definitionId,omitempty"`
	// The business key of the process instance.
	BusinessKey string `json:"businessKey,omitempty"`
	// The id of the case instance associated with the process instance.
	CaseInstanceId string `json:"caseInstanceId,omitempty"`
	// A flag indicating whether the process instance has ended or not. Deprecated: will always be false!
	Ended bool `json:"ended,omitempty"`
	// A flag indicating whether the process instance is suspended or not.
	Suspended bool `json:"suspended,omitempty"`
	// The tenant id of the process instance.
	TenantId string `json:"tenantId,omitempty"`
}

ProcessInstanceDtoAllOf struct for ProcessInstanceDtoAllOf

type ProcessInstanceModificationDto

type ProcessInstanceModificationDto struct {
	// Skip execution listener invocation for activities that are started or ended as part of this request.
	SkipCustomListeners *bool `json:"skipCustomListeners,omitempty"`
	// Skip execution of [input/output variable mappings](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables/#input-output-variable-mapping) for activities that are started or ended as part of this request.
	SkipIoMappings *bool `json:"skipIoMappings,omitempty"`
	// JSON array of modification instructions. The instructions are executed in the order they are in.
	Instructions []ProcessInstanceModificationInstructionDto `json:"instructions,omitempty"`
	// An arbitrary text annotation set by a user for auditing reasons.
	Annotation string `json:"annotation,omitempty"`
}

ProcessInstanceModificationDto struct for ProcessInstanceModificationDto

type ProcessInstanceModificationInstructionDto

type ProcessInstanceModificationInstructionDto struct {
	// **Mandatory**. One of the following values: `cancel`, `startBeforeActivity`, `startAfterActivity`, `startTransition`.  * A cancel instruction requests cancellation of a single activity instance or all instances of one activity. * A startBeforeActivity instruction requests to enter a given activity. * A startAfterActivity instruction requests to execute the single outgoing sequence flow of a given activity. * A startTransition instruction requests to execute a specific sequence flow.
	Type      string                  `json:"type"`
	Variables TriggerVariableValueDto `json:"variables,omitempty"`
	// Can be used with instructions of types `startTransition`. Specifies the sequence flow to start.
	ActivityId string `json:"activityId,omitempty"`
	// Can be used with instructions of types `startTransition`. Specifies the sequence flow to start.
	TransitionId string `json:"transitionId,omitempty"`
	// Can be used with instructions of type `cancel`. Specifies the activity instance to cancel. Valid values are the activity instance IDs supplied by the [Get Activity Instance request](https://docs.camunda.org/manual/7.13/reference/rest/process-instance/get-activity-instances/).
	ActivityInstanceId string `json:"activityInstanceId,omitempty"`
	// Can be used with instructions of type `cancel`. Specifies the transition instance to cancel. Valid values are the transition instance IDs supplied by the [Get Activity Instance request](https://docs.camunda.org/manual/7.13/reference/rest/process-instance/get-activity-instances/).
	TransitionInstanceId string `json:"transitionInstanceId,omitempty"`
	// Can be used with instructions of type `startBeforeActivity`, `startAfterActivity`, and `startTransition`. Valid values are the activity instance IDs supplied by the Get Activity Instance request. If there are multiple parent activity instances of the targeted activity, this specifies the ancestor scope in which hierarchy the activity/transition is to be instantiated.  Example: When there are two instances of a subprocess and an activity contained in the subprocess is to be started, this parameter allows to specifiy under which subprocess instance the activity should be started.
	AncestorActivityInstanceId string `json:"ancestorActivityInstanceId,omitempty"`
	// Can be used with instructions of type cancel. Prevents the deletion of new created activity instances.
	CancelCurrentActiveActivityInstances *bool `json:"cancelCurrentActiveActivityInstances,omitempty"`
}

ProcessInstanceModificationInstructionDto struct for ProcessInstanceModificationInstructionDto

type ProcessInstanceQueryDto

type ProcessInstanceQueryDto struct {
	// Filter by the deployment the id belongs to.
	DeploymentId string `json:"deploymentId,omitempty"`
	// Filter by the process definition the instances run on.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// Filter by the key of the process definition the instances run on.
	ProcessDefinitionKey string `json:"processDefinitionKey,omitempty"`
	// Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Must be a JSON array of Strings.
	ProcessDefinitionKeyIn []string `json:"processDefinitionKeyIn,omitempty"`
	// Exclude instances by a list of process definition keys. A process instance must not have one of the given process definition keys. Must be a JSON array of Strings.
	ProcessDefinitionKeyNotIn []string `json:"processDefinitionKeyNotIn,omitempty"`
	// Filter by process instance business key.
	BusinessKey string `json:"businessKey,omitempty"`
	// Filter by process instance business key that the parameter is a substring of.
	BusinessKeyLike string `json:"businessKeyLike,omitempty"`
	// Filter by case instance id.
	CaseInstanceId string `json:"caseInstanceId,omitempty"`
	// Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id.
	SuperProcessInstance string `json:"superProcessInstance,omitempty"`
	// Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id.
	SubProcessInstance string `json:"subProcessInstance,omitempty"`
	// Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
	SuperCaseInstance string `json:"superCaseInstance,omitempty"`
	// Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id.
	SubCaseInstance string `json:"subCaseInstance,omitempty"`
	// Only include active process instances. Value may only be true, as false is the default behavior.
	Active *bool `json:"active,omitempty"`
	// Only include suspended process instances. Value may only be true, as false is the default behavior.
	Suspended *bool `json:"suspended,omitempty"`
	// Filter by a list of process instance ids. Must be a JSON array of Strings.
	ProcessInstanceIds []string `json:"processInstanceIds,omitempty"`
	// Filter by presence of incidents. Selects only process instances that have an incident.
	WithIncident *bool `json:"withIncident,omitempty"`
	// Filter by the incident id.
	IncidentId string `json:"incidentId,omitempty"`
	// Filter by the incident type. See the User Guide for a list of incident types.
	IncidentType string `json:"incidentType,omitempty"`
	// Filter by the incident message. Exact match.
	IncidentMessage string `json:"incidentMessage,omitempty"`
	// Filter by the incident message that the parameter is a substring of.
	IncidentMessageLike string `json:"incidentMessageLike,omitempty"`
	// Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Must be a JSON array of Strings.
	TenantIdIn []string `json:"tenantIdIn,omitempty"`
	// Only include process instances which belong to no tenant. Value may only be true, as false is the default behavior.
	WithoutTenantId *bool `json:"withoutTenantId,omitempty"`
	// Only include process instances which process definition has no tenant id.
	ProcessDefinitionWithoutTenantId *bool `json:"processDefinitionWithoutTenantId,omitempty"`
	// Filter by a list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids.
	ActivityIdIn []string `json:"activityIdIn,omitempty"`
	// Restrict the query to all process instances that are top level process instances.
	RootProcessInstances *bool `json:"rootProcessInstances,omitempty"`
	// Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances)
	LeafProcessInstances *bool `json:"leafProcessInstances,omitempty"`
	// A JSON array to only include process instances that have variables with certain values. The array consists of objects with the three properties `name`, `operator` and `value`. `name` (String) is the variable name, `operator` (String) is the comparison operator to be used and `value` the variable value. The `value` may be String, Number or Boolean.  Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`.
	Variables []VariableQueryParameterDto `json:"variables,omitempty"`
	// Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal.
	VariableNamesIgnoreCase *bool `json:"variableNamesIgnoreCase,omitempty"`
	// Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal.
	VariableValuesIgnoreCase *bool `json:"variableValuesIgnoreCase,omitempty"`
	// A JSON array of nested process instance queries with OR semantics. A process instance matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a process instance must fulfill at least one predicate of each query (Conjunctive Normal Form). All process instance query properties can be used except for: `sorting` See the [User guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/process-engine-api/#or-queries) for more information about OR queries.
	OrQueries []ProcessInstanceQueryDto `json:"orQueries,omitempty"`
	// Apply sorting of the result
	Sorting []ProcessInstanceQueryDtoSorting `json:"sorting,omitempty"`
}

ProcessInstanceQueryDto A process instance query which defines a group of process instances

type ProcessInstanceQueryDtoSorting

type ProcessInstanceQueryDtoSorting struct {
	// Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
	SortBy string `json:"sortBy,omitempty"`
	// Sort the results in a given order. Values may be `asc` for ascending order or `desc` for descending order. Must be used in conjunction with the sortBy parameter.
	SortOrder string `json:"sortOrder,omitempty"`
}

ProcessInstanceQueryDtoSorting struct for ProcessInstanceQueryDtoSorting

type ProcessInstanceSuspensionStateAsyncDto

type ProcessInstanceSuspensionStateAsyncDto struct {
	// A Boolean value which indicates whether to activate or suspend a given process instance. When the value is set to true, the given process instance will be suspended and when the value is set to false, the given process instance will be activated.
	Suspended *bool `json:"suspended,omitempty"`
	// A list of process instance ids which defines a group of process instances which will be activated or suspended by the operation.
	ProcessInstanceIds           []string                        `json:"processInstanceIds,omitempty"`
	ProcessInstanceQuery         ProcessInstanceQueryDto         `json:"processInstanceQuery,omitempty"`
	HistoricProcessInstanceQuery HistoricProcessInstanceQueryDto `json:"historicProcessInstanceQuery,omitempty"`
}

ProcessInstanceSuspensionStateAsyncDto struct for ProcessInstanceSuspensionStateAsyncDto

type ProcessInstanceSuspensionStateDto

type ProcessInstanceSuspensionStateDto struct {
	// A `Boolean` value which indicates whether to activate or suspend a given process instance. When the value is set to `true`, the given process instance will be suspended and when the value is set to `false`, the given process instance will be activated.
	Suspended *bool `json:"suspended,omitempty"`
	// The process definition id of the process instances to activate or suspend.  **Note**: This parameter can be used only with combination of `suspended`.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// The process definition key of the process instances to activate or suspend.  **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionTenantId`, and `processDefinitionWithoutTenantId`.
	ProcessDefinitionKey string `json:"processDefinitionKey,omitempty"`
	// Only activate or suspend process instances of a process definition which belongs to a tenant with the given id.  **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionKey`, and `processDefinitionWithoutTenantId`.
	ProcessDefinitionTenantId string `json:"processDefinitionTenantId,omitempty"`
	// Only activate or suspend process instances of a process definition which belongs to no tenant. Value may only be true, as false is the default behavior.  **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionKey`, and `processDefinitionTenantId`.
	ProcessDefinitionWithoutTenantId *bool `json:"processDefinitionWithoutTenantId,omitempty"`
	// A list of process instance ids which defines a group of process instances which will be activated or suspended by the operation.  **Note**: This parameter can be used only with combination of `suspended`, `processInstanceQuery`, and `historicProcessInstanceQuery`.
	ProcessInstanceIds           []string                        `json:"processInstanceIds,omitempty"`
	ProcessInstanceQuery         ProcessInstanceQueryDto         `json:"processInstanceQuery,omitempty"`
	HistoricProcessInstanceQuery HistoricProcessInstanceQueryDto `json:"historicProcessInstanceQuery,omitempty"`
}

ProcessInstanceSuspensionStateDto struct for ProcessInstanceSuspensionStateDto

type ProcessInstanceWithVariablesDto

type ProcessInstanceWithVariablesDto struct {
	// The id of the process instance.
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
	// The id of the process instance.
	Id string `json:"id,omitempty"`
	// The id of the process definition that this process instance belongs to.
	DefinitionId string `json:"definitionId,omitempty"`
	// The business key of the process instance.
	BusinessKey string `json:"businessKey,omitempty"`
	// The id of the case instance associated with the process instance.
	CaseInstanceId string `json:"caseInstanceId,omitempty"`
	// A flag indicating whether the process instance has ended or not. Deprecated: will always be false!
	Ended bool `json:"ended,omitempty"`
	// A flag indicating whether the process instance is suspended or not.
	Suspended bool `json:"suspended,omitempty"`
	// The tenant id of the process instance.
	TenantId string `json:"tenantId,omitempty"`
	// The links associated to this resource, with `method`, `href` and `rel`.
	Links []AtomLink `json:"links,omitempty"`
}

ProcessInstanceWithVariablesDto struct for ProcessInstanceWithVariablesDto

type ProcessInstanceWithVariablesDtoAllOf

type ProcessInstanceWithVariablesDtoAllOf struct {
	// The id of the process instance.
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
}

ProcessInstanceWithVariablesDtoAllOf struct for ProcessInstanceWithVariablesDtoAllOf

type PutTaskLocalVariableOpts

type PutTaskLocalVariableOpts struct {
	VariableValueDto optional.Interface
}

PutTaskLocalVariableOpts Optional parameters for the method 'PutTaskLocalVariable'

type PutTaskVariableOpts

type PutTaskVariableOpts struct {
	VariableValueDto optional.Interface
}

PutTaskVariableOpts Optional parameters for the method 'PutTaskVariable'

type QueryExternalTasksCountOpts

type QueryExternalTasksCountOpts struct {
	ExternalTaskQueryDto optional.Interface
}

QueryExternalTasksCountOpts Optional parameters for the method 'QueryExternalTasksCount'

type QueryExternalTasksOpts

type QueryExternalTasksOpts struct {
	FirstResult          optional.Int32
	MaxResults           optional.Int32
	ExternalTaskQueryDto optional.Interface
}

QueryExternalTasksOpts Optional parameters for the method 'QueryExternalTasks'

type QueryProcessInstancesCountOpts

type QueryProcessInstancesCountOpts struct {
	ProcessInstanceQueryDto optional.Interface
}

QueryProcessInstancesCountOpts Optional parameters for the method 'QueryProcessInstancesCount'

type QueryProcessInstancesOpts

type QueryProcessInstancesOpts struct {
	FirstResult             optional.Int32
	MaxResults              optional.Int32
	ProcessInstanceQueryDto optional.Interface
}

QueryProcessInstancesOpts Optional parameters for the method 'QueryProcessInstances'

type QuerySchemaLogOpts

type QuerySchemaLogOpts struct {
	FirstResult       optional.Int32
	MaxResults        optional.Int32
	SchemaLogQueryDto optional.Interface
}

QuerySchemaLogOpts Optional parameters for the method 'QuerySchemaLog'

type QueryTasksCountOpts

type QueryTasksCountOpts struct {
	TaskQueryDto optional.Interface
}

QueryTasksCountOpts Optional parameters for the method 'QueryTasksCount'

type QueryTasksOpts

type QueryTasksOpts struct {
	FirstResult  optional.Int32
	MaxResults   optional.Int32
	TaskQueryDto optional.Interface
}

QueryTasksOpts Optional parameters for the method 'QueryTasks'

type RedeployOpts

type RedeployOpts struct {
	RedeploymentDto optional.Interface
}

RedeployOpts Optional parameters for the method 'Redeploy'

type RedeploymentDto

type RedeploymentDto struct {
	// A list of deployment resource ids to re-deploy.
	ResourceIds []string `json:"resourceIds,omitempty"`
	// A list of deployment resource names to re-deploy.
	ResourceNames []string `json:"resourceNames,omitempty"`
	// Sets the source of the deployment.
	Source string `json:"source,omitempty"`
}

RedeploymentDto A JSON object with the following properties:

type ResolveOpts

type ResolveOpts struct {
	CompleteTaskDto optional.Interface
}

ResolveOpts Optional parameters for the method 'Resolve'

type ResourceReportDto

type ResourceReportDto struct {
	// A list of errors occurred during parsing.
	Errors []ProblemDto `json:"errors,omitempty"`
	// A list of warnings occurred during parsing.
	Warnings []ProblemDto `json:"warnings,omitempty"`
}

ResourceReportDto struct for ResourceReportDto

type RestartProcessInstanceAsyncOperationOpts

type RestartProcessInstanceAsyncOperationOpts struct {
	RestartProcessInstanceDto optional.Interface
}

RestartProcessInstanceAsyncOperationOpts Optional parameters for the method 'RestartProcessInstanceAsyncOperation'

type RestartProcessInstanceDto

type RestartProcessInstanceDto struct {
	// A list of process instance ids to restart.
	ProcessInstanceIds           []string                        `json:"processInstanceIds,omitempty"`
	HistoricProcessInstanceQuery HistoricProcessInstanceQueryDto `json:"historicProcessInstanceQuery,omitempty"`
	// Skip execution listener invocation for activities that are started as part of this request.
	SkipCustomListeners *bool `json:"skipCustomListeners,omitempty"`
	// Skip execution of [input/output variable mappings](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables/#input-output-variable-mapping) for activities that are started as part of this request.
	SkipIoMappings *bool `json:"skipIoMappings,omitempty"`
	// Set the initial set of variables during restart. By default, the last set of variables is used.
	InitialVariables *bool `json:"initialVariables,omitempty"`
	// Do not take over the business key of the historic process instance.
	WithoutBusinessKey *bool `json:"withoutBusinessKey,omitempty"`
	// **Optional**. A JSON array of instructions that specify which activities to start the process instance at. If this property is omitted, the process instance starts at its default blank start event.
	Instructions []RestartProcessInstanceModificationInstructionDto `json:"instructions,omitempty"`
}

RestartProcessInstanceDto struct for RestartProcessInstanceDto

type RestartProcessInstanceModificationInstructionDto

type RestartProcessInstanceModificationInstructionDto struct {
	// **Mandatory**. One of the following values: `startBeforeActivity`, `startAfterActivity`, `startTransition`.  * A `startBeforeActivity` instruction requests to enter a given activity. * A `startAfterActivity` instruction requests to execute the single outgoing sequence flow of a given activity. * A `startTransition` instruction requests to execute a specific sequence flow.
	Type string `json:"type"`
	// **Can be used with instructions of types** `startBeforeActivity` and `startAfterActivity`. Specifies the sequence flow to start.
	ActivityId string `json:"activityId,omitempty"`
	// **Can be used with instructions of types** `startTransition`. Specifies the sequence flow to start.
	TransitionId string `json:"transitionId,omitempty"`
}

RestartProcessInstanceModificationInstructionDto struct for RestartProcessInstanceModificationInstructionDto

type RestartProcessInstanceOpts

type RestartProcessInstanceOpts struct {
	RestartProcessInstanceDto optional.Interface
}

RestartProcessInstanceOpts Optional parameters for the method 'RestartProcessInstance'

type RetriesDto

type RetriesDto struct {
	// The number of retries to set for the resource.  Must be >= 0. If this is 0, an incident is created and the task, or job, cannot be fetched, or acquired anymore unless the retries are increased again. Can not be null.
	Retries *int32 `json:"retries,omitempty"`
}

RetriesDto struct for RetriesDto

type SchemaLogApiService

type SchemaLogApiService service

SchemaLogApiService SchemaLogApi service

func (*SchemaLogApiService) GetSchemaLog

func (a *SchemaLogApiService) GetSchemaLog(ctx _context.Context, localVarOptionals *GetSchemaLogOpts) ([]SchemaLogEntryDto, *_nethttp.Response, error)

GetSchemaLog Method for GetSchemaLog Queries for schema log entries that fulfill given parameters.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetSchemaLogOpts - Optional Parameters:
  • @param "Version" (optional.String) - Only return schema log entries with a specific version.
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

@return []SchemaLogEntryDto

func (*SchemaLogApiService) QuerySchemaLog

func (a *SchemaLogApiService) QuerySchemaLog(ctx _context.Context, localVarOptionals *QuerySchemaLogOpts) ([]SchemaLogEntryDto, *_nethttp.Response, error)

QuerySchemaLog Method for QuerySchemaLog Queries for schema log entries that fulfill given parameters.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *QuerySchemaLogOpts - Optional Parameters:
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
  • @param "SchemaLogQueryDto" (optional.Interface of SchemaLogQueryDto) -

@return []SchemaLogEntryDto

type SchemaLogEntryDto

type SchemaLogEntryDto struct {
	// The id of the schema log entry.
	Id string `json:"id,omitempty"`
	// The date and time of the schema update.
	Timestamp string `json:"timestamp,omitempty"`
	// The version of the schema.
	Version string `json:"version,omitempty"`
}

SchemaLogEntryDto struct for SchemaLogEntryDto

type SchemaLogQueryDto

type SchemaLogQueryDto struct {
	// The version of the schema.
	Version string `json:"version,omitempty"`
	// A JSON array of criteria to sort the result by. Each element of the array is                       a JSON object that specifies one ordering. The position in the array                       identifies the rank of an ordering, i.e., whether it is primary, secondary,                       etc.
	Sorting []SchemaLogQueryDtoSorting `json:"sorting,omitempty"`
}

SchemaLogQueryDto struct for SchemaLogQueryDto

type SchemaLogQueryDtoSorting

type SchemaLogQueryDtoSorting struct {
	// Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
	SortBy string `json:"sortBy,omitempty"`
	// Sort the results in a given order. Values may be `asc` for ascending order or `desc` for descending order. Must be used in conjunction with the sortBy parameter.
	SortOrder string `json:"sortOrder,omitempty"`
}

SchemaLogQueryDtoSorting struct for SchemaLogQueryDtoSorting

type SetAssigneeOpts

type SetAssigneeOpts struct {
	UserIdDto optional.Interface
}

SetAssigneeOpts Optional parameters for the method 'SetAssignee'

type SetBinaryTaskLocalVariableOpts

type SetBinaryTaskLocalVariableOpts struct {
	Data      optional.Interface
	ValueType optional.String
}

SetBinaryTaskLocalVariableOpts Optional parameters for the method 'SetBinaryTaskLocalVariable'

type SetBinaryTaskVariableOpts

type SetBinaryTaskVariableOpts struct {
	Data      optional.Interface
	ValueType optional.String
}

SetBinaryTaskVariableOpts Optional parameters for the method 'SetBinaryTaskVariable'

type SetExternalTaskResourcePriorityOpts

type SetExternalTaskResourcePriorityOpts struct {
	PriorityDto optional.Interface
}

SetExternalTaskResourcePriorityOpts Optional parameters for the method 'SetExternalTaskResourcePriority'

type SetExternalTaskResourceRetriesOpts

type SetExternalTaskResourceRetriesOpts struct {
	RetriesDto optional.Interface
}

SetExternalTaskResourceRetriesOpts Optional parameters for the method 'SetExternalTaskResourceRetries'

type SetExternalTaskRetriesAsyncOperationOpts

type SetExternalTaskRetriesAsyncOperationOpts struct {
	SetRetriesForExternalTasksDto optional.Interface
}

SetExternalTaskRetriesAsyncOperationOpts Optional parameters for the method 'SetExternalTaskRetriesAsyncOperation'

type SetExternalTaskRetriesOpts

type SetExternalTaskRetriesOpts struct {
	SetRetriesForExternalTasksDto optional.Interface
}

SetExternalTaskRetriesOpts Optional parameters for the method 'SetExternalTaskRetries'

type SetJobRetriesByProcessDto

type SetJobRetriesByProcessDto struct {
	// A list of process instance ids to fetch jobs, for which retries will be set.
	ProcessInstances []string `json:"processInstances,omitempty"`
	// An integer representing the number of retries. Please note that the value cannot be negative or null.
	Retries                      *int32                          `json:"retries,omitempty"`
	ProcessInstanceQuery         ProcessInstanceQueryDto         `json:"processInstanceQuery,omitempty"`
	HistoricProcessInstanceQuery HistoricProcessInstanceQueryDto `json:"historicProcessInstanceQuery,omitempty"`
}

SetJobRetriesByProcessDto struct for SetJobRetriesByProcessDto

type SetProcessInstanceVariableBinaryOpts

type SetProcessInstanceVariableBinaryOpts struct {
	Data      optional.Interface
	ValueType optional.String
}

SetProcessInstanceVariableBinaryOpts Optional parameters for the method 'SetProcessInstanceVariableBinary'

type SetProcessInstanceVariableOpts

type SetProcessInstanceVariableOpts struct {
	VariableValueDto optional.Interface
}

SetProcessInstanceVariableOpts Optional parameters for the method 'SetProcessInstanceVariable'

type SetRetriesByProcessHistoricQueryBasedOpts

type SetRetriesByProcessHistoricQueryBasedOpts struct {
	SetJobRetriesByProcessDto optional.Interface
}

SetRetriesByProcessHistoricQueryBasedOpts Optional parameters for the method 'SetRetriesByProcessHistoricQueryBased'

type SetRetriesByProcessOpts

type SetRetriesByProcessOpts struct {
	SetJobRetriesByProcessDto optional.Interface
}

SetRetriesByProcessOpts Optional parameters for the method 'SetRetriesByProcess'

type SetRetriesForExternalTasksDto

type SetRetriesForExternalTasksDto struct {
	// The number of retries to set for the external task.  Must be >= 0. If this is 0, an incident is created and the task cannot be fetched anymore unless the retries are increased again. Can not be null.
	Retries *int32 `json:"retries,omitempty"`
	// The ids of the external tasks to set the number of retries for.
	ExternalTaskIds []string `json:"externalTaskIds,omitempty"`
	// The ids of process instances containing the tasks to set the number of retries for.
	ProcessInstanceIds           []string                        `json:"processInstanceIds,omitempty"`
	ExternalTaskQuery            ExternalTaskQueryDto            `json:"externalTaskQuery,omitempty"`
	ProcessInstanceQuery         ProcessInstanceQueryDto         `json:"processInstanceQuery,omitempty"`
	HistoricProcessInstanceQuery HistoricProcessInstanceQueryDto `json:"historicProcessInstanceQuery,omitempty"`
}

SetRetriesForExternalTasksDto struct for SetRetriesForExternalTasksDto

type SignalApiService

type SignalApiService service

SignalApiService SignalApi service

func (*SignalApiService) ThrowSignal

func (a *SignalApiService) ThrowSignal(ctx _context.Context, localVarOptionals *ThrowSignalOpts) (*_nethttp.Response, error)

ThrowSignal Method for ThrowSignal A signal is an event of global scope (broadcast semantics) and is delivered to all active handlers. Internally this maps to the engine's signal event received builder method `RuntimeService#createSignalEvent()`. For more information about the signal behavior, see the [Signal Events](https://docs.camunda.org/manual/7.13/reference/bpmn20/events/signal-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.13/reference/bpmn20/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ThrowSignalOpts - Optional Parameters:
  • @param "SignalDto" (optional.Interface of SignalDto) -

type SignalDto

type SignalDto struct {
	// The name of the signal to deliver.  **Note**: This property is mandatory.
	Name string `json:"name,omitempty"`
	// Optionally specifies a single execution which is notified by the signal.  **Note**: If no execution id is defined the signal is broadcasted to all subscribed handlers.
	ExecutionId string `json:"executionId,omitempty"`
	// A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object.
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
	// Specifies a tenant to deliver the signal. The signal can only be received on executions or process definitions which belongs to the given tenant.  **Note**: Cannot be used in combination with executionId.
	TenantId string `json:"tenantId,omitempty"`
	// If true the signal can only be received on executions or process definitions which belongs to no tenant. Value may not be false as this is the default behavior.  **Note**: Cannot be used in combination with `executionId`.
	WithoutTenantId *bool `json:"withoutTenantId,omitempty"`
}

SignalDto struct for SignalDto

type SortTaskQueryParametersDto

type SortTaskQueryParametersDto struct {
	// The name of the variable to sort by.
	Variable string `json:"variable,omitempty"`
	// The name of the type of the variable value.
	Type string `json:"type,omitempty"`
}

SortTaskQueryParametersDto Mandatory when `sortBy` is one of the following values: `processVariable`, `executionVariable`, `taskVariable`, `caseExecutionVariable` or `caseInstanceVariable`. Must be a JSON object with the properties `variable` and `type` where `variable` is a variable name and `type` is the name of a variable value type.

type StartProcessInstanceByKeyAndTenantIdOpts

type StartProcessInstanceByKeyAndTenantIdOpts struct {
	StartProcessInstanceDto optional.Interface
}

StartProcessInstanceByKeyAndTenantIdOpts Optional parameters for the method 'StartProcessInstanceByKeyAndTenantId'

type StartProcessInstanceByKeyOpts

type StartProcessInstanceByKeyOpts struct {
	StartProcessInstanceDto optional.Interface
}

StartProcessInstanceByKeyOpts Optional parameters for the method 'StartProcessInstanceByKey'

type StartProcessInstanceDto

type StartProcessInstanceDto struct {
	// The business key of the process instance.
	BusinessKey string                      `json:"businessKey,omitempty"`
	Variables   map[string]VariableValueDto `json:"variables,omitempty"`
	// The case instance id the process instance is to be initialized with.
	CaseInstanceId string `json:"caseInstanceId,omitempty"`
	// **Optional**. A JSON array of instructions that specify which activities to start the process instance at. If this property is omitted, the process instance starts at its default blank start event.
	StartInstructions []ProcessInstanceModificationInstructionDto `json:"startInstructions,omitempty"`
	// Skip execution listener invocation for activities that are started or ended as part of this request. **Note**: This option is currently only respected when start instructions are submitted via the `startInstructions` property.
	SkipCustomListeners *bool `json:"skipCustomListeners,omitempty"`
	// Skip execution of [input/output variable mappings](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables/#input-output-variable-mapping) for activities that are started or ended as part of this request. **Note**: This option is currently only respected when start instructions are submitted via the `startInstructions` property.
	SkipIoMappings *bool `json:"skipIoMappings,omitempty"`
	// Indicates if the variables, which was used by the process instance during execution, should be returned. Default value: `false`
	WithVariablesInReturn *bool `json:"withVariablesInReturn,omitempty"`
}

StartProcessInstanceDto struct for StartProcessInstanceDto

type StartProcessInstanceFormDto

type StartProcessInstanceFormDto struct {
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
	// The business key the process instance is to be initialized with. The business key uniquely identifies the process instance in the context of the given process definition.
	BusinessKey string `json:"businessKey,omitempty"`
}

StartProcessInstanceFormDto struct for StartProcessInstanceFormDto

type StartProcessInstanceOpts

type StartProcessInstanceOpts struct {
	StartProcessInstanceDto optional.Interface
}

StartProcessInstanceOpts Optional parameters for the method 'StartProcessInstance'

type SubmitFormByKeyAndTenantIdOpts

type SubmitFormByKeyAndTenantIdOpts struct {
	StartProcessInstanceFormDto optional.Interface
}

SubmitFormByKeyAndTenantIdOpts Optional parameters for the method 'SubmitFormByKeyAndTenantId'

type SubmitFormByKeyOpts

type SubmitFormByKeyOpts struct {
	StartProcessInstanceFormDto optional.Interface
}

SubmitFormByKeyOpts Optional parameters for the method 'SubmitFormByKey'

type SubmitFormOpts

type SubmitFormOpts struct {
	StartProcessInstanceFormDto optional.Interface
}

SubmitFormOpts Optional parameters for the method 'SubmitForm'

type SubmitOpts

type SubmitOpts struct {
	CompleteTaskDto optional.Interface
}

SubmitOpts Optional parameters for the method 'Submit'

type SuspensionStateDto

type SuspensionStateDto struct {
	// A Boolean value which indicates whether to activate or suspend a given process instance. When the value is set to true, the given process instance will be suspended and when the value is set to false, the given process instance will be activated.
	Suspended bool `json:"suspended,omitempty"`
}

SuspensionStateDto struct for SuspensionStateDto

type TaskApiService

type TaskApiService service

TaskApiService TaskApi service

func (*TaskApiService) Claim

func (a *TaskApiService) Claim(ctx _context.Context, id string, localVarOptionals *ClaimOpts) (*_nethttp.Response, error)

Claim Method for Claim Claims a task for a specific user. **Note:** The difference with the [Set Assignee](https://docs.camunda.org/manual/7.13/reference/rest/task/post-assignee/) method is that here a check is performed to see if the task already has a user assigned to it.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to claim.
  • @param optional nil or *ClaimOpts - Optional Parameters:
  • @param "UserIdDto" (optional.Interface of UserIdDto) - Provide the id of the user that claims the task.

func (*TaskApiService) Complete

func (a *TaskApiService) Complete(ctx _context.Context, id string, localVarOptionals *CompleteOpts) (map[string]VariableValueDto, *_nethttp.Response, error)

Complete Method for Complete Completes a task and updates process variables.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to complete.
  • @param optional nil or *CompleteOpts - Optional Parameters:
  • @param "CompleteTaskDto" (optional.Interface of CompleteTaskDto) -

@return map[string]VariableValueDto

func (*TaskApiService) CreateTask

func (a *TaskApiService) CreateTask(ctx _context.Context, localVarOptionals *CreateTaskOpts) (*_nethttp.Response, error)

CreateTask Method for CreateTask Creates a new task.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateTaskOpts - Optional Parameters:
  • @param "TaskDto" (optional.Interface of TaskDto) -

func (*TaskApiService) DelegateTask

func (a *TaskApiService) DelegateTask(ctx _context.Context, id string, localVarOptionals *DelegateTaskOpts) (*_nethttp.Response, error)

DelegateTask Method for DelegateTask Delegates a task to another user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to delegate.
  • @param optional nil or *DelegateTaskOpts - Optional Parameters:
  • @param "UserIdDto" (optional.Interface of UserIdDto) - Provide the id of the user that the task should be delegated to.

func (*TaskApiService) DeleteTask

func (a *TaskApiService) DeleteTask(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteTask Method for DeleteTask Removes a task by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to be removed.

func (*TaskApiService) GetDeployedForm

func (a *TaskApiService) GetDeployedForm(ctx _context.Context, id string) (*os.File, *_nethttp.Response, error)

GetDeployedForm Method for GetDeployedForm Retrieves the deployed form that is referenced from a given task. For further information please refer to the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#embedded-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to get the deployed form for.

@return *os.File

func (*TaskApiService) GetForm

GetForm Method for GetForm Retrieves the form key for a task. The form key corresponds to the `FormData#formKey` property in the engine. This key can be used to do task-specific form rendering in client applications. Additionally, the context path of the containing process application is returned.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the form for.

@return FormDto

func (*TaskApiService) GetFormVariables

func (a *TaskApiService) GetFormVariables(ctx _context.Context, id string, localVarOptionals *GetFormVariablesOpts) (map[string]VariableValueDto, *_nethttp.Response, error)

GetFormVariables Method for GetFormVariables Retrieves the form variables for a task. The form variables take form data specified on the task into account. If form fields are defined, the variable types and default values of the form fields are taken into account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the variables for.
  • @param optional nil or *GetFormVariablesOpts - Optional Parameters:
  • @param "VariableNames" (optional.String) - A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored.
  • @param "DeserializeValues" (optional.Bool) - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](http://jackson.codehaus.org/) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine.

@return map[string]VariableValueDto

func (*TaskApiService) GetRenderedForm

func (a *TaskApiService) GetRenderedForm(ctx _context.Context, id string) (*os.File, *_nethttp.Response, error)

GetRenderedForm Method for GetRenderedForm Retrieves the rendered form for a task. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.13/user-guide/task-forms/#generated-task-forms).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to get the rendered form for.

@return *os.File

func (*TaskApiService) GetTask

GetTask Method for GetTask Retrieves a task by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to be retrieved.

@return TaskDto

func (*TaskApiService) GetTasks

func (a *TaskApiService) GetTasks(ctx _context.Context, localVarOptionals *GetTasksOpts) ([]TaskDto, *_nethttp.Response, error)

GetTasks Method for GetTasks Queries for tasks that fulfill a given filter. The size of the result set can be retrieved by using the Get Task Count method. **Security Consideration:** There are several query parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations](https://docs.camunda.org/manual/7.13/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetTasksOpts - Optional Parameters:
  • @param "ProcessInstanceId" (optional.String) - Restrict to tasks that belong to process instances with the given id.
  • @param "ProcessInstanceIdIn" (optional.String) - Restrict to tasks that belong to process instances with the given ids.
  • @param "ProcessInstanceBusinessKey" (optional.String) - Restrict to tasks that belong to process instances with the given business key.
  • @param "ProcessInstanceBusinessKeyExpression" (optional.String) - Restrict to tasks that belong to process instances with the given business key which is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "ProcessInstanceBusinessKeyIn" (optional.String) - Restrict to tasks that belong to process instances with one of the give business keys. The keys need to be in a comma-separated list.
  • @param "ProcessInstanceBusinessKeyLike" (optional.String) - Restrict to tasks that have a process instance business key that has the parameter value as a substring.
  • @param "ProcessInstanceBusinessKeyLikeExpression" (optional.String) - Restrict to tasks that have a process instance business key that has the parameter value as a substring and is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "ProcessDefinitionId" (optional.String) - Restrict to tasks that belong to a process definition with the given id.
  • @param "ProcessDefinitionKey" (optional.String) - Restrict to tasks that belong to a process definition with the given key.
  • @param "ProcessDefinitionKeyIn" (optional.String) - Restrict to tasks that belong to a process definition with one of the given keys. The keys need to be in a comma-separated list.
  • @param "ProcessDefinitionName" (optional.String) - Restrict to tasks that belong to a process definition with the given name.
  • @param "ProcessDefinitionNameLike" (optional.String) - Restrict to tasks that have a process definition name that has the parameter value as a substring.
  • @param "ExecutionId" (optional.String) - Restrict to tasks that belong to an execution with the given id.
  • @param "CaseInstanceId" (optional.String) - Restrict to tasks that belong to case instances with the given id.
  • @param "CaseInstanceBusinessKey" (optional.String) - Restrict to tasks that belong to case instances with the given business key.
  • @param "CaseInstanceBusinessKeyLike" (optional.String) - Restrict to tasks that have a case instance business key that has the parameter value as a substring.
  • @param "CaseDefinitionId" (optional.String) - Restrict to tasks that belong to a case definition with the given id.
  • @param "CaseDefinitionKey" (optional.String) - Restrict to tasks that belong to a case definition with the given key.
  • @param "CaseDefinitionName" (optional.String) - Restrict to tasks that belong to a case definition with the given name.
  • @param "CaseDefinitionNameLike" (optional.String) - Restrict to tasks that have a case definition name that has the parameter value as a substring.
  • @param "CaseExecutionId" (optional.String) - Restrict to tasks that belong to a case execution with the given id.
  • @param "ActivityInstanceIdIn" (optional.String) - Only include tasks which belong to one of the passed and comma-separated activity instance ids.
  • @param "TenantIdIn" (optional.String) - Only include tasks which belong to one of the passed and comma-separated tenant ids.
  • @param "WithoutTenantId" (optional.Bool) - Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior.
  • @param "Assignee" (optional.String) - Restrict to tasks that the given user is assigned to.
  • @param "AssigneeExpression" (optional.String) - Restrict to tasks that the user described by the given expression is assigned to. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "AssigneeLike" (optional.String) - Restrict to tasks that have an assignee that has the parameter value as a substring.
  • @param "AssigneeLikeExpression" (optional.String) - Restrict to tasks that have an assignee that has the parameter value described by the given expression as a substring. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "AssigneeIn" (optional.String) - Only include tasks which are assigned to one of the passed and comma-separated user ids.
  • @param "Owner" (optional.String) - Restrict to tasks that the given user owns.
  • @param "OwnerExpression" (optional.String) - Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "CandidateGroup" (optional.String) - Only include tasks that are offered to the given group.
  • @param "CandidateGroupExpression" (optional.String) - Only include tasks that are offered to the group described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "CandidateUser" (optional.String) - Only include tasks that are offered to the given user or to one of his groups.
  • @param "CandidateUserExpression" (optional.String) - Only include tasks that are offered to the user described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "IncludeAssignedTasks" (optional.Bool) - Also include tasks that are assigned to users in candidate queries. Default is to only include tasks that are not assigned to any user if you query by candidate user or group(s).
  • @param "InvolvedUser" (optional.String) - Only include tasks that the given user is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee).
  • @param "InvolvedUserExpression" (optional.String) - Only include tasks that the user described by the given expression is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "Assigned" (optional.Bool) - If set to `true`, restricts the query to all tasks that are assigned.
  • @param "Unassigned" (optional.Bool) - If set to `true`, restricts the query to all tasks that are unassigned.
  • @param "TaskDefinitionKey" (optional.String) - Restrict to tasks that have the given key.
  • @param "TaskDefinitionKeyIn" (optional.String) - Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list.
  • @param "TaskDefinitionKeyLike" (optional.String) - Restrict to tasks that have a key that has the parameter value as a substring.
  • @param "Name" (optional.String) - Restrict to tasks that have the given name.
  • @param "NameNotEqual" (optional.String) - Restrict to tasks that do not have the given name.
  • @param "NameLike" (optional.String) - Restrict to tasks that have a name with the given parameter value as substring.
  • @param "NameNotLike" (optional.String) - Restrict to tasks that do not have a name with the given parameter value as substring.
  • @param "Description" (optional.String) - Restrict to tasks that have the given description.
  • @param "DescriptionLike" (optional.String) - Restrict to tasks that have a description that has the parameter value as a substring.
  • @param "Priority" (optional.Int32) - Restrict to tasks that have the given priority.
  • @param "MaxPriority" (optional.Int32) - Restrict to tasks that have a lower or equal priority.
  • @param "MinPriority" (optional.Int32) - Restrict to tasks that have a higher or equal priority.
  • @param "DueDate" (optional.String) - Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "DueDateExpression" (optional.String) - Restrict to tasks that are due on the date described by the given expression. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "DueAfter" (optional.String) - Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "DueAfterExpression" (optional.String) - Restrict to tasks that are due after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "DueBefore" (optional.String) - Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "DueBeforeExpression" (optional.String) - Restrict to tasks that are due before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "FollowUpDate" (optional.String) - Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "FollowUpDateExpression" (optional.String) - Restrict to tasks that have a followUp date on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "FollowUpAfter" (optional.String) - Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "FollowUpAfterExpression" (optional.String) - Restrict to tasks that have a followUp date after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "FollowUpBefore" (optional.String) - Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "FollowUpBeforeExpression" (optional.String) - Restrict to tasks that have a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "FollowUpBeforeOrNotExistent" (optional.String) - Restrict to tasks that have no followUp date or a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`. The typical use case is to query all `active` tasks for a user for a given date.
  • @param "FollowUpBeforeOrNotExistentExpression" (optional.String) - Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "CreatedOn" (optional.String) - Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "CreatedOnExpression" (optional.String) - Restrict to tasks that were created on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "CreatedAfter" (optional.String) - Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "CreatedAfterExpression" (optional.String) - Restrict to tasks that were created after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "CreatedBefore" (optional.String) - Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "CreatedBeforeExpression" (optional.String) - Restrict to tasks that were created before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "DelegationState" (optional.String) - Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`.
  • @param "CandidateGroups" (optional.String) - Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example `developers,support,sales`.
  • @param "CandidateGroupsExpression" (optional.String) - Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to `java.util.List` of Strings.
  • @param "WithCandidateGroups" (optional.Bool) - Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior.
  • @param "WithoutCandidateGroups" (optional.Bool) - Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior.
  • @param "WithCandidateUsers" (optional.Bool) - Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior.
  • @param "WithoutCandidateUsers" (optional.Bool) - Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior.
  • @param "Active" (optional.Bool) - Only include active tasks. Value may only be `true`, as `false` is the default behavior.
  • @param "Suspended" (optional.Bool) - Only include suspended tasks. Value may only be `true`, as `false` is the default behavior.
  • @param "TaskVariables" (optional.String) - Only include tasks that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
  • @param "ProcessVariables" (optional.String) - Only include tasks that belong to process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
  • @param "CaseInstanceVariables" (optional.String) - Only include tasks that belong to case instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
  • @param "VariableNamesIgnoreCase" (optional.Bool) - Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal.
  • @param "VariableValuesIgnoreCase" (optional.Bool) - Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal.
  • @param "ParentTaskId" (optional.String) - Restrict query to all tasks that are sub tasks of the given task. Takes a task id.
  • @param "SortBy" (optional.String) - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
  • @param "SortOrder" (optional.String) - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

@return []TaskDto

func (*TaskApiService) GetTasksCount

func (a *TaskApiService) GetTasksCount(ctx _context.Context, localVarOptionals *GetTasksCountOpts) (CountResultDto, *_nethttp.Response, error)

GetTasksCount Method for GetTasksCount Retrieves the number of tasks that fulfill a provided filter. Corresponds to the size of the result set when using the [Get Tasks](https://docs.camunda.org/manual/7.13/reference/rest/task/) method. **Security Consideration:** There are several query parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations](https://docs.camunda.org/manual/7.13/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetTasksCountOpts - Optional Parameters:
  • @param "ProcessInstanceId" (optional.String) - Restrict to tasks that belong to process instances with the given id.
  • @param "ProcessInstanceIdIn" (optional.String) - Restrict to tasks that belong to process instances with the given ids.
  • @param "ProcessInstanceBusinessKey" (optional.String) - Restrict to tasks that belong to process instances with the given business key.
  • @param "ProcessInstanceBusinessKeyExpression" (optional.String) - Restrict to tasks that belong to process instances with the given business key which is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "ProcessInstanceBusinessKeyIn" (optional.String) - Restrict to tasks that belong to process instances with one of the give business keys. The keys need to be in a comma-separated list.
  • @param "ProcessInstanceBusinessKeyLike" (optional.String) - Restrict to tasks that have a process instance business key that has the parameter value as a substring.
  • @param "ProcessInstanceBusinessKeyLikeExpression" (optional.String) - Restrict to tasks that have a process instance business key that has the parameter value as a substring and is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "ProcessDefinitionId" (optional.String) - Restrict to tasks that belong to a process definition with the given id.
  • @param "ProcessDefinitionKey" (optional.String) - Restrict to tasks that belong to a process definition with the given key.
  • @param "ProcessDefinitionKeyIn" (optional.String) - Restrict to tasks that belong to a process definition with one of the given keys. The keys need to be in a comma-separated list.
  • @param "ProcessDefinitionName" (optional.String) - Restrict to tasks that belong to a process definition with the given name.
  • @param "ProcessDefinitionNameLike" (optional.String) - Restrict to tasks that have a process definition name that has the parameter value as a substring.
  • @param "ExecutionId" (optional.String) - Restrict to tasks that belong to an execution with the given id.
  • @param "CaseInstanceId" (optional.String) - Restrict to tasks that belong to case instances with the given id.
  • @param "CaseInstanceBusinessKey" (optional.String) - Restrict to tasks that belong to case instances with the given business key.
  • @param "CaseInstanceBusinessKeyLike" (optional.String) - Restrict to tasks that have a case instance business key that has the parameter value as a substring.
  • @param "CaseDefinitionId" (optional.String) - Restrict to tasks that belong to a case definition with the given id.
  • @param "CaseDefinitionKey" (optional.String) - Restrict to tasks that belong to a case definition with the given key.
  • @param "CaseDefinitionName" (optional.String) - Restrict to tasks that belong to a case definition with the given name.
  • @param "CaseDefinitionNameLike" (optional.String) - Restrict to tasks that have a case definition name that has the parameter value as a substring.
  • @param "CaseExecutionId" (optional.String) - Restrict to tasks that belong to a case execution with the given id.
  • @param "ActivityInstanceIdIn" (optional.String) - Only include tasks which belong to one of the passed and comma-separated activity instance ids.
  • @param "TenantIdIn" (optional.String) - Only include tasks which belong to one of the passed and comma-separated tenant ids.
  • @param "WithoutTenantId" (optional.Bool) - Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior.
  • @param "Assignee" (optional.String) - Restrict to tasks that the given user is assigned to.
  • @param "AssigneeExpression" (optional.String) - Restrict to tasks that the user described by the given expression is assigned to. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "AssigneeLike" (optional.String) - Restrict to tasks that have an assignee that has the parameter value as a substring.
  • @param "AssigneeLikeExpression" (optional.String) - Restrict to tasks that have an assignee that has the parameter value described by the given expression as a substring. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "AssigneeIn" (optional.String) - Only include tasks which are assigned to one of the passed and comma-separated user ids.
  • @param "Owner" (optional.String) - Restrict to tasks that the given user owns.
  • @param "OwnerExpression" (optional.String) - Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "CandidateGroup" (optional.String) - Only include tasks that are offered to the given group.
  • @param "CandidateGroupExpression" (optional.String) - Only include tasks that are offered to the group described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "CandidateUser" (optional.String) - Only include tasks that are offered to the given user or to one of his groups.
  • @param "CandidateUserExpression" (optional.String) - Only include tasks that are offered to the user described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "IncludeAssignedTasks" (optional.Bool) - Also include tasks that are assigned to users in candidate queries. Default is to only include tasks that are not assigned to any user if you query by candidate user or group(s).
  • @param "InvolvedUser" (optional.String) - Only include tasks that the given user is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee).
  • @param "InvolvedUserExpression" (optional.String) - Only include tasks that the user described by the given expression is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
  • @param "Assigned" (optional.Bool) - If set to `true`, restricts the query to all tasks that are assigned.
  • @param "Unassigned" (optional.Bool) - If set to `true`, restricts the query to all tasks that are unassigned.
  • @param "TaskDefinitionKey" (optional.String) - Restrict to tasks that have the given key.
  • @param "TaskDefinitionKeyIn" (optional.String) - Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list.
  • @param "TaskDefinitionKeyLike" (optional.String) - Restrict to tasks that have a key that has the parameter value as a substring.
  • @param "Name" (optional.String) - Restrict to tasks that have the given name.
  • @param "NameNotEqual" (optional.String) - Restrict to tasks that do not have the given name.
  • @param "NameLike" (optional.String) - Restrict to tasks that have a name with the given parameter value as substring.
  • @param "NameNotLike" (optional.String) - Restrict to tasks that do not have a name with the given parameter value as substring.
  • @param "Description" (optional.String) - Restrict to tasks that have the given description.
  • @param "DescriptionLike" (optional.String) - Restrict to tasks that have a description that has the parameter value as a substring.
  • @param "Priority" (optional.Int32) - Restrict to tasks that have the given priority.
  • @param "MaxPriority" (optional.Int32) - Restrict to tasks that have a lower or equal priority.
  • @param "MinPriority" (optional.Int32) - Restrict to tasks that have a higher or equal priority.
  • @param "DueDate" (optional.String) - Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "DueDateExpression" (optional.String) - Restrict to tasks that are due on the date described by the given expression. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "DueAfter" (optional.String) - Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "DueAfterExpression" (optional.String) - Restrict to tasks that are due after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "DueBefore" (optional.String) - Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "DueBeforeExpression" (optional.String) - Restrict to tasks that are due before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "FollowUpDate" (optional.String) - Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "FollowUpDateExpression" (optional.String) - Restrict to tasks that have a followUp date on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "FollowUpAfter" (optional.String) - Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "FollowUpAfterExpression" (optional.String) - Restrict to tasks that have a followUp date after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "FollowUpBefore" (optional.String) - Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "FollowUpBeforeExpression" (optional.String) - Restrict to tasks that have a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "FollowUpBeforeOrNotExistent" (optional.String) - Restrict to tasks that have no followUp date or a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`. The typical use case is to query all `active` tasks for a user for a given date.
  • @param "FollowUpBeforeOrNotExistentExpression" (optional.String) - Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "CreatedOn" (optional.String) - Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "CreatedOnExpression" (optional.String) - Restrict to tasks that were created on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "CreatedAfter" (optional.String) - Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "CreatedAfterExpression" (optional.String) - Restrict to tasks that were created after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "CreatedBefore" (optional.String) - Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
  • @param "CreatedBeforeExpression" (optional.String) - Restrict to tasks that were created before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
  • @param "DelegationState" (optional.String) - Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`.
  • @param "CandidateGroups" (optional.String) - Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example `developers,support,sales`.
  • @param "CandidateGroupsExpression" (optional.String) - Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to `java.util.List` of Strings.
  • @param "WithCandidateGroups" (optional.Bool) - Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior.
  • @param "WithoutCandidateGroups" (optional.Bool) - Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior.
  • @param "WithCandidateUsers" (optional.Bool) - Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior.
  • @param "WithoutCandidateUsers" (optional.Bool) - Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior.
  • @param "Active" (optional.Bool) - Only include active tasks. Value may only be `true`, as `false` is the default behavior.
  • @param "Suspended" (optional.Bool) - Only include suspended tasks. Value may only be `true`, as `false` is the default behavior.
  • @param "TaskVariables" (optional.String) - Only include tasks that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
  • @param "ProcessVariables" (optional.String) - Only include tasks that belong to process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
  • @param "CaseInstanceVariables" (optional.String) - Only include tasks that belong to case instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
  • @param "VariableNamesIgnoreCase" (optional.Bool) - Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal.
  • @param "VariableValuesIgnoreCase" (optional.Bool) - Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal.
  • @param "ParentTaskId" (optional.String) - Restrict query to all tasks that are sub tasks of the given task. Takes a task id.

@return CountResultDto

func (*TaskApiService) HandleBpmnError

func (a *TaskApiService) HandleBpmnError(ctx _context.Context, id string, localVarOptionals *HandleBpmnErrorOpts) (*_nethttp.Response, error)

HandleBpmnError Method for HandleBpmnError Reports a business error in the context of a running task by id. The error code must be specified to identify the BPMN error handler. See the documentation for [Reporting Bpmn Error](https://docs.camunda.org/manual/7.13/reference/bpmn20/tasks/user-task/#reporting-bpmn-error) in User Tasks.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task a BPMN error is reported for.
  • @param optional nil or *HandleBpmnErrorOpts - Optional Parameters:
  • @param "TaskBpmnErrorDto" (optional.Interface of TaskBpmnErrorDto) -

func (*TaskApiService) HandleEscalation

func (a *TaskApiService) HandleEscalation(ctx _context.Context, id string, localVarOptionals *HandleEscalationOpts) (*_nethttp.Response, error)

HandleEscalation Method for HandleEscalation Reports an escalation in the context of a running task by id. The escalation code must be specified to identify the escalation handler. See the documentation for [Reporting Bpmn Escalation](https://docs.camunda.org/manual/7.13/reference/bpmn20/tasks/user-task/#reporting-bpmn-escalation) in User Tasks.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task in which context a BPMN escalation is reported.
  • @param optional nil or *HandleEscalationOpts - Optional Parameters:
  • @param "TaskEscalationDto" (optional.Interface of TaskEscalationDto) -

func (*TaskApiService) QueryTasks

func (a *TaskApiService) QueryTasks(ctx _context.Context, localVarOptionals *QueryTasksOpts) ([]TaskDto, *_nethttp.Response, error)

QueryTasks Method for QueryTasks Queries for tasks that fulfill a given filter. This method is slightly more powerful than the [Get Tasks](https://docs.camunda.org/manual/7.13/reference/rest/task/get-query/) method because it allows filtering by multiple process or task variables of types `String`, `Number` or `Boolean`. The size of the result set can be retrieved by using the [Get Task Count (POST)](https://docs.camunda.org/manual/7.13/reference/rest/task/post-query-count/) method. **Security Consideration**: There are several parameters (such as `assigneeExpression`) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations for custom code](https://docs.camunda.org/manual/7.13/user-guide/process-engine/securing-custom-code/) in the user guide for details.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *QueryTasksOpts - Optional Parameters:
  • @param "FirstResult" (optional.Int32) - Pagination of results. Specifies the index of the first result to return.
  • @param "MaxResults" (optional.Int32) - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
  • @param "TaskQueryDto" (optional.Interface of TaskQueryDto) -

@return []TaskDto

func (*TaskApiService) QueryTasksCount

func (a *TaskApiService) QueryTasksCount(ctx _context.Context, localVarOptionals *QueryTasksCountOpts) (CountResultDto, *_nethttp.Response, error)

QueryTasksCount Method for QueryTasksCount Retrieves the number of tasks that fulfill the given filter. Corresponds to the size of the result set of the [Get Tasks (POST)](https://docs.camunda.org/manual/7.13/reference/rest/task/post-query/) method and takes the same parameters. **Security Consideration**: There are several parameters (such as `assigneeExpression`) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations for custom code](https://docs.camunda.org/manual/7.13/user-guide/process-engine/securing-custom-code/) in the user guide for details.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *QueryTasksCountOpts - Optional Parameters:
  • @param "TaskQueryDto" (optional.Interface of TaskQueryDto) -

@return CountResultDto

func (*TaskApiService) Resolve

func (a *TaskApiService) Resolve(ctx _context.Context, id string, localVarOptionals *ResolveOpts) (*_nethttp.Response, error)

Resolve Method for Resolve Resolves a task and updates execution variables. Resolving a task marks that the assignee is done with the task delegated to them, and that it can be sent back to the owner. Can only be executed when the task has been delegated. The assignee will be set to the owner, who performed the delegation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to resolve.
  • @param optional nil or *ResolveOpts - Optional Parameters:
  • @param "CompleteTaskDto" (optional.Interface of CompleteTaskDto) -

func (*TaskApiService) SetAssignee

func (a *TaskApiService) SetAssignee(ctx _context.Context, id string, localVarOptionals *SetAssigneeOpts) (*_nethttp.Response, error)

SetAssignee Method for SetAssignee Changes the assignee of a task to a specific user. **Note:** The difference with the [Claim Task](https://docs.camunda.org/manual/7.13/reference/rest/task/post-claim/) method is that this method does not check if the task already has a user assigned to it.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to set the assignee for.
  • @param optional nil or *SetAssigneeOpts - Optional Parameters:
  • @param "UserIdDto" (optional.Interface of UserIdDto) - Provide the id of the user that will be the assignee of the task.

func (*TaskApiService) Submit

func (a *TaskApiService) Submit(ctx _context.Context, id string, localVarOptionals *SubmitOpts) (map[string]VariableValueDto, *_nethttp.Response, error)

Submit Method for Submit Completes a task and updates process variables using a form submit. There are two difference between this method and the `complete` method: * If the task is in state `PENDING` - i.e., has been delegated before, it is not completed but resolved. Otherwise it will be completed. * If the task has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See the [Generated Task Forms](https://docs.camunda.org/manual/7.13/user-guide/task-forms/_index/#generated-task-forms) section of the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/) for more information.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to submit the form for.
  • @param optional nil or *SubmitOpts - Optional Parameters:
  • @param "CompleteTaskDto" (optional.Interface of CompleteTaskDto) -

@return map[string]VariableValueDto

func (*TaskApiService) Unclaim

func (a *TaskApiService) Unclaim(ctx _context.Context, id string) (*_nethttp.Response, error)

Unclaim Method for Unclaim Resets a task's assignee. If successful, the task is not assigned to a user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to unclaim.

func (*TaskApiService) UpdateTask

func (a *TaskApiService) UpdateTask(ctx _context.Context, id string, localVarOptionals *UpdateTaskOpts) (*_nethttp.Response, error)

UpdateTask Method for UpdateTask Updates a task.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to be updated.
  • @param optional nil or *UpdateTaskOpts - Optional Parameters:
  • @param "TaskDto" (optional.Interface of TaskDto) -

type TaskAttachmentApiService

type TaskAttachmentApiService service

TaskAttachmentApiService TaskAttachmentApi service

func (*TaskAttachmentApiService) AddAttachment

func (a *TaskAttachmentApiService) AddAttachment(ctx _context.Context, id string, localVarOptionals *AddAttachmentOpts) (AttachmentDto, *_nethttp.Response, error)

AddAttachment Method for AddAttachment Creates an attachment for a task.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to add the attachment to.
  • @param optional nil or *AddAttachmentOpts - Optional Parameters:
  • @param "AttachmentName" (optional.String) - The name of the attachment.
  • @param "AttachmentDescription" (optional.String) - The description of the attachment.
  • @param "AttachmentType" (optional.String) - The type of the attachment.
  • @param "Url" (optional.String) - The url to the remote content of the attachment.
  • @param "Content" (optional.Interface of *os.File) - The content of the attachment.

@return AttachmentDto

func (*TaskAttachmentApiService) DeleteAttachment

func (a *TaskAttachmentApiService) DeleteAttachment(ctx _context.Context, id string, attachmentId string) (*_nethttp.Response, error)

DeleteAttachment Method for DeleteAttachment Removes an attachment from a task by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task.
  • @param attachmentId The id of the attachment to be removed.

func (*TaskAttachmentApiService) GetAttachment

func (a *TaskAttachmentApiService) GetAttachment(ctx _context.Context, id string, attachmentId string) (AttachmentDto, *_nethttp.Response, error)

GetAttachment Method for GetAttachment Retrieves a task attachment by task id and attachment id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task.
  • @param attachmentId The id of the attachment to be retrieved.

@return AttachmentDto

func (*TaskAttachmentApiService) GetAttachmentData

func (a *TaskAttachmentApiService) GetAttachmentData(ctx _context.Context, id string, attachmentId string) (*os.File, *_nethttp.Response, error)

GetAttachmentData Method for GetAttachmentData Retrieves the binary content of a task attachment by task id and attachment id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task.
  • @param attachmentId The id of the attachment to be retrieved.

@return *os.File

func (*TaskAttachmentApiService) GetAttachments

GetAttachments Method for GetAttachments Gets the attachments for a task.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the attachments for.

@return []AttachmentDto

type TaskBpmnErrorDto

type TaskBpmnErrorDto struct {
	// An error code that indicates the predefined error. It is used to identify the BPMN error handler.
	ErrorCode string `json:"errorCode,omitempty"`
	// An error message that describes the error.
	ErrorMessage string `json:"errorMessage,omitempty"`
	// A JSON object containing variable key-value pairs.
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
}

TaskBpmnErrorDto struct for TaskBpmnErrorDto

type TaskCommentApiService

type TaskCommentApiService service

TaskCommentApiService TaskCommentApi service

func (*TaskCommentApiService) CreateComment

func (a *TaskCommentApiService) CreateComment(ctx _context.Context, id string, localVarOptionals *CreateCommentOpts) (CommentDto, *_nethttp.Response, error)

CreateComment Method for CreateComment Creates a comment for a task by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to add the comment to.
  • @param optional nil or *CreateCommentOpts - Optional Parameters:
  • @param "CommentDto" (optional.Interface of CommentDto) - **Note:** Only the `message` property will be used. Every other property passed to this endpoint will be ignored.

@return CommentDto

func (*TaskCommentApiService) GetComment

func (a *TaskCommentApiService) GetComment(ctx _context.Context, id string, commentId string) (CommentDto, *_nethttp.Response, error)

GetComment Method for GetComment Retrieves a task comment by task id and comment id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task.
  • @param commentId The id of the comment to be retrieved.

@return CommentDto

func (*TaskCommentApiService) GetComments

GetComments Method for GetComments Gets the comments for a task by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the comments for.

@return []CommentDto

type TaskDto

type TaskDto struct {
	// The task id.
	Id string `json:"id,omitempty"`
	// The task name.
	Name string `json:"name,omitempty"`
	// The assignee's id.
	Assignee string `json:"assignee,omitempty"`
	// The owner's id.
	Owner string `json:"owner,omitempty"`
	// The date the task was created on. [Default format](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	Created string `json:"created,omitempty"`
	// The task's due date. [Default format](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	Due *string `json:"due,omitempty"`
	// The follow-up date for the task. [Default format](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/) `yyyy-MM-dd' 'HH:mm:ss`.
	FollowUp *string `json:"followUp,omitempty"`
	// The task's delegation state. Possible values are `PENDING` and `RESOLVED`.
	DelegationState string `json:"delegationState,omitempty"`
	// The task's description.
	Description string `json:"description,omitempty"`
	// The id of the execution the task belongs to.
	ExecutionId string `json:"executionId,omitempty"`
	// The id the parent task, if this task is a subtask.
	ParentTaskId string `json:"parentTaskId,omitempty"`
	// The task's priority.
	Priority *int32 `json:"priority,omitempty"`
	// The id of the process definition the task belongs to.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// The id of the process instance the task belongs to.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// The id of the case execution the task belongs to.
	CaseExecutionId string `json:"caseExecutionId,omitempty"`
	// The id of the case definition the task belongs to.
	CaseDefinitionId string `json:"caseDefinitionId,omitempty"`
	// The id of the case instance the task belongs to.
	CaseInstanceId string `json:"caseInstanceId,omitempty"`
	// The task's key.
	TaskDefinitionKey string `json:"taskDefinitionKey,omitempty"`
	// Whether the task belongs to a process instance that is suspended.
	Suspended *bool `json:"suspended,omitempty"`
	// If not `null`, the form key for the task.
	FormKey string `json:"formKey,omitempty"`
	// If not `null`, the tenant id of the task.
	TenantId string `json:"tenantId,omitempty"`
}

TaskDto struct for TaskDto

type TaskEscalationDto

type TaskEscalationDto struct {
	// An escalation code that indicates the predefined escalation. It is used to identify the BPMN escalation handler.
	EscalationCode string `json:"escalationCode,omitempty"`
	// A JSON object containing variable key-value pairs.
	Variables map[string]VariableValueDto `json:"variables,omitempty"`
}

TaskEscalationDto struct for TaskEscalationDto

type TaskIdentityLinkApiService

type TaskIdentityLinkApiService service

TaskIdentityLinkApiService TaskIdentityLinkApi service

func (a *TaskIdentityLinkApiService) AddIdentityLink(ctx _context.Context, id string, localVarOptionals *AddIdentityLinkOpts) (*_nethttp.Response, error)

AddIdentityLink Method for AddIdentityLink Adds an identity link to a task by id. Can be used to link any user or group to a task and specify a relation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to add a link to.
  • @param optional nil or *AddIdentityLinkOpts - Optional Parameters:
  • @param "IdentityLinkDto" (optional.Interface of IdentityLinkDto) -
func (a *TaskIdentityLinkApiService) DeleteIdentityLink(ctx _context.Context, id string, localVarOptionals *DeleteIdentityLinkOpts) (*_nethttp.Response, error)

DeleteIdentityLink Method for DeleteIdentityLink Removes an identity link from a task by id

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to remove a link from.
  • @param optional nil or *DeleteIdentityLinkOpts - Optional Parameters:
  • @param "IdentityLinkDto" (optional.Interface of IdentityLinkDto) -
func (a *TaskIdentityLinkApiService) GetIdentityLinks(ctx _context.Context, id string, localVarOptionals *GetIdentityLinksOpts) ([]IdentityLinkDto, *_nethttp.Response, error)

GetIdentityLinks Method for GetIdentityLinks Gets the identity links for a task by id, which are the users and groups that are in *some* relation to it (including assignee and owner).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the identity links for.
  • @param optional nil or *GetIdentityLinksOpts - Optional Parameters:
  • @param "Type_" (optional.String) - Filter by the type of links to include.

@return []IdentityLinkDto

type TaskLocalVariableApiService

type TaskLocalVariableApiService service

TaskLocalVariableApiService TaskLocalVariableApi service

func (*TaskLocalVariableApiService) DeleteTaskLocalVariable

func (a *TaskLocalVariableApiService) DeleteTaskLocalVariable(ctx _context.Context, id string, varName string) (*_nethttp.Response, error)

DeleteTaskLocalVariable Method for DeleteTaskLocalVariable Removes a local variable from a task by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to delete the variable from.
  • @param varName The name of the variable to be removed.

func (*TaskLocalVariableApiService) GetTaskLocalVariable

func (a *TaskLocalVariableApiService) GetTaskLocalVariable(ctx _context.Context, id string, varName string, localVarOptionals *GetTaskLocalVariableOpts) (VariableValueDto, *_nethttp.Response, error)

GetTaskLocalVariable Method for GetTaskLocalVariable Retrieves a variable from the context of a given task by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the variable from.
  • @param varName The name of the variable to get
  • @param optional nil or *GetTaskLocalVariableOpts - Optional Parameters:
  • @param "DeserializeValue" (optional.Bool) - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine.

@return VariableValueDto

func (*TaskLocalVariableApiService) GetTaskLocalVariableBinary

func (a *TaskLocalVariableApiService) GetTaskLocalVariableBinary(ctx _context.Context, id string, varName string) (*os.File, *_nethttp.Response, error)

GetTaskLocalVariableBinary Method for GetTaskLocalVariableBinary Retrieves a binary variable from the context of a given task by id. Applicable for byte array and file variables.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the variable for.
  • @param varName The name of the variable to retrieve.

@return *os.File

func (*TaskLocalVariableApiService) GetTaskLocalVariables

func (a *TaskLocalVariableApiService) GetTaskLocalVariables(ctx _context.Context, id string, localVarOptionals *GetTaskLocalVariablesOpts) (map[string]VariableValueDto, *_nethttp.Response, error)

GetTaskLocalVariables Method for GetTaskLocalVariables Retrieves all variables of a given task by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the variables from.
  • @param optional nil or *GetTaskLocalVariablesOpts - Optional Parameters:
  • @param "DeserializeValues" (optional.Bool) - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine.

@return map[string]VariableValueDto

func (*TaskLocalVariableApiService) ModifyTaskLocalVariables

func (a *TaskLocalVariableApiService) ModifyTaskLocalVariables(ctx _context.Context, id string, localVarOptionals *ModifyTaskLocalVariablesOpts) (*_nethttp.Response, error)

ModifyTaskLocalVariables Method for ModifyTaskLocalVariables Updates or deletes the variables in the context of a task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to set variables for.
  • @param optional nil or *ModifyTaskLocalVariablesOpts - Optional Parameters:
  • @param "PatchVariablesDto" (optional.Interface of PatchVariablesDto) -

func (*TaskLocalVariableApiService) PutTaskLocalVariable

func (a *TaskLocalVariableApiService) PutTaskLocalVariable(ctx _context.Context, id string, varName string, localVarOptionals *PutTaskLocalVariableOpts) (*_nethttp.Response, error)

PutTaskLocalVariable Method for PutTaskLocalVariable Sets a variable in the context of a given task.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to set the variable for.
  • @param varName The name of the variable to set.
  • @param optional nil or *PutTaskLocalVariableOpts - Optional Parameters:
  • @param "VariableValueDto" (optional.Interface of VariableValueDto) -

func (*TaskLocalVariableApiService) SetBinaryTaskLocalVariable

func (a *TaskLocalVariableApiService) SetBinaryTaskLocalVariable(ctx _context.Context, id string, varName string, localVarOptionals *SetBinaryTaskLocalVariableOpts) (*_nethttp.Response, error)

SetBinaryTaskLocalVariable Method for SetBinaryTaskLocalVariable Sets the serialized value for a binary variable or the binary value for a file variable.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the variable for.
  • @param varName The name of the variable to retrieve.
  • @param optional nil or *SetBinaryTaskLocalVariableOpts - Optional Parameters:
  • @param "Data" (optional.Interface of *os.File) - The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory.
  • @param "ValueType" (optional.String) - The name of the variable type. Either Bytes for a byte array variable or File for a file variable.

type TaskQueryDto

type TaskQueryDto struct {
	// Restrict to tasks that belong to process instances with the given id.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// Restrict to tasks that belong to process instances with the given ids.
	ProcessInstanceIdIn []string `json:"processInstanceIdIn,omitempty"`
	// Restrict to tasks that belong to process instances with the given business key.
	ProcessInstanceBusinessKey string `json:"processInstanceBusinessKey,omitempty"`
	// Restrict to tasks that belong to process instances with the given business key which  is described by an expression. See the  [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
	ProcessInstanceBusinessKeyExpression string `json:"processInstanceBusinessKeyExpression,omitempty"`
	// Restrict to tasks that belong to process instances with one of the give business keys.  The keys need to be in a comma-separated list.
	ProcessInstanceBusinessKeyIn []string `json:"processInstanceBusinessKeyIn,omitempty"`
	// Restrict to tasks that have a process instance business key that has the parameter  value as a substring.
	ProcessInstanceBusinessKeyLike string `json:"processInstanceBusinessKeyLike,omitempty"`
	// Restrict to tasks that have a process instance business key that has the parameter  value as a substring and is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions)  for more information on available functions.
	ProcessInstanceBusinessKeyLikeExpression string `json:"processInstanceBusinessKeyLikeExpression,omitempty"`
	// Restrict to tasks that belong to a process definition with the given id.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// Restrict to tasks that belong to a process definition with the given key.
	ProcessDefinitionKey string `json:"processDefinitionKey,omitempty"`
	// Restrict to tasks that belong to a process definition with one of the given keys. The  keys need to be in a comma-separated list.
	ProcessDefinitionKeyIn []string `json:"processDefinitionKeyIn,omitempty"`
	// Restrict to tasks that belong to a process definition with the given name.
	ProcessDefinitionName string `json:"processDefinitionName,omitempty"`
	// Restrict to tasks that have a process definition name that has the parameter value as  a substring.
	ProcessDefinitionNameLike string `json:"processDefinitionNameLike,omitempty"`
	// Restrict to tasks that belong to an execution with the given id.
	ExecutionId string `json:"executionId,omitempty"`
	// Restrict to tasks that belong to case instances with the given id.
	CaseInstanceId string `json:"caseInstanceId,omitempty"`
	// Restrict to tasks that belong to case instances with the given business key.
	CaseInstanceBusinessKey string `json:"caseInstanceBusinessKey,omitempty"`
	// Restrict to tasks that have a case instance business key that has the parameter value  as a substring.
	CaseInstanceBusinessKeyLike string `json:"caseInstanceBusinessKeyLike,omitempty"`
	// Restrict to tasks that belong to a case definition with the given id.
	CaseDefinitionId string `json:"caseDefinitionId,omitempty"`
	// Restrict to tasks that belong to a case definition with the given key.
	CaseDefinitionKey string `json:"caseDefinitionKey,omitempty"`
	// Restrict to tasks that belong to a case definition with the given name.
	CaseDefinitionName string `json:"caseDefinitionName,omitempty"`
	// Restrict to tasks that have a case definition name that has the parameter value as a  substring.
	CaseDefinitionNameLike string `json:"caseDefinitionNameLike,omitempty"`
	// Restrict to tasks that belong to a case execution with the given id.
	CaseExecutionId string `json:"caseExecutionId,omitempty"`
	// Only include tasks which belong to one of the passed and comma-separated activity  instance ids.
	ActivityInstanceIdIn []string `json:"activityInstanceIdIn,omitempty"`
	// Only include tasks which belong to one of the passed and comma-separated  tenant ids.
	TenantIdIn []string `json:"tenantIdIn,omitempty"`
	// Only include tasks which belong to no tenant. Value may only be `true`,  as `false` is the default behavior.
	WithoutTenantId *bool `json:"withoutTenantId,omitempty"`
	// Restrict to tasks that the given user is assigned to.
	Assignee string `json:"assignee,omitempty"`
	// Restrict to tasks that the user described by the given expression is assigned to. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions)  for more information on available functions.
	AssigneeExpression string `json:"assigneeExpression,omitempty"`
	// Restrict to tasks that have an assignee that has the parameter  value as a substring.
	AssigneeLike string `json:"assigneeLike,omitempty"`
	// Restrict to tasks that have an assignee that has the parameter value described by the  given expression as a substring. See the  [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions)  for more information on available functions.
	AssigneeLikeExpression string `json:"assigneeLikeExpression,omitempty"`
	// Only include tasks which are assigned to one of the passed and comma-separated user ids.
	AssigneeIn []string `json:"assigneeIn,omitempty"`
	// Restrict to tasks that the given user owns.
	Owner string `json:"owner,omitempty"`
	// Restrict to tasks that the user described by the given expression owns. See the  [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions)  for more information on available functions.
	OwnerExpression string `json:"ownerExpression,omitempty"`
	// Only include tasks that are offered to the given group.
	CandidateGroup string `json:"candidateGroup,omitempty"`
	// Only include tasks that are offered to the group described by the given expression.  See the  [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions)  for more information on available functions.
	CandidateGroupExpression string `json:"candidateGroupExpression,omitempty"`
	// Only include tasks that are offered to the given user or to one of his groups.
	CandidateUser string `json:"candidateUser,omitempty"`
	// Only include tasks that are offered to the user described by the given expression.  See the  [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions)  for more information on available functions.
	CandidateUserExpression string `json:"candidateUserExpression,omitempty"`
	// Also include tasks that are assigned to users in candidate queries. Default is to only  include tasks that are not assigned to any user if you query by candidate user or group(s).
	IncludeAssignedTasks *bool `json:"includeAssignedTasks,omitempty"`
	// Only include tasks that the given user is involved in. A user is involved in a task if  an identity link exists between task and user (e.g., the user is the assignee).
	InvolvedUser string `json:"involvedUser,omitempty"`
	// Only include tasks that the user described by the given expression is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
	InvolvedUserExpression string `json:"involvedUserExpression,omitempty"`
	// If set to `true`, restricts the query to all tasks that are assigned.
	Assigned *bool `json:"assigned,omitempty"`
	// If set to `true`, restricts the query to all tasks that are unassigned.
	Unassigned *bool `json:"unassigned,omitempty"`
	// Restrict to tasks that have the given key.
	TaskDefinitionKey string `json:"taskDefinitionKey,omitempty"`
	// Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list.
	TaskDefinitionKeyIn []string `json:"taskDefinitionKeyIn,omitempty"`
	// Restrict to tasks that have a key that has the parameter value as a substring.
	TaskDefinitionKeyLike string `json:"taskDefinitionKeyLike,omitempty"`
	// Restrict to tasks that have the given name.
	Name string `json:"name,omitempty"`
	// Restrict to tasks that do not have the given name.
	NameNotEqual string `json:"nameNotEqual,omitempty"`
	// Restrict to tasks that have a name with the given parameter value as substring.
	NameLike string `json:"nameLike,omitempty"`
	// Restrict to tasks that do not have a name with the given parameter value as substring.
	NameNotLike string `json:"nameNotLike,omitempty"`
	// Restrict to tasks that have the given description.
	Description string `json:"description,omitempty"`
	// Restrict to tasks that have a description that has the parameter value as a substring.
	DescriptionLike string `json:"descriptionLike,omitempty"`
	// Restrict to tasks that have the given priority.
	Priority *int32 `json:"priority,omitempty"`
	// Restrict to tasks that have a lower or equal priority.
	MaxPriority *int32 `json:"maxPriority,omitempty"`
	// Restrict to tasks that have a higher or equal priority.
	MinPriority *int32 `json:"minPriority,omitempty"`
	// Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	DueDate *string `json:"dueDate,omitempty"`
	// Restrict to tasks that are due on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
	DueDateExpression string `json:"dueDateExpression,omitempty"`
	// Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	DueAfter *string `json:"dueAfter,omitempty"`
	// Restrict to tasks that are due after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
	DueAfterExpression string `json:"dueAfterExpression,omitempty"`
	// Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	DueBefore *string `json:"dueBefore,omitempty"`
	// Restrict to tasks that are due before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
	DueBeforeExpression string `json:"dueBeforeExpression,omitempty"`
	// Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	FollowUpDate *string `json:"followUpDate,omitempty"`
	// Restrict to tasks that have a followUp date on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
	FollowUpDateExpression string `json:"followUpDateExpression,omitempty"`
	// Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	FollowUpAfter *string `json:"followUpAfter,omitempty"`
	// Restrict to tasks that have a followUp date after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
	FollowUpAfterExpression string `json:"followUpAfterExpression,omitempty"`
	// Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	FollowUpBefore string `json:"followUpBefore,omitempty"`
	// Restrict to tasks that have a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
	FollowUpBeforeExpression string `json:"followUpBeforeExpression,omitempty"`
	// Restrict to tasks that have no followUp date or a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`. The typical use case is to query all `active` tasks for a user for a given date.
	FollowUpBeforeOrNotExistent *string `json:"followUpBeforeOrNotExistent,omitempty"`
	// Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
	FollowUpBeforeOrNotExistentExpression string `json:"followUpBeforeOrNotExistentExpression,omitempty"`
	// Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	CreatedOn *string `json:"createdOn,omitempty"`
	// Restrict to tasks that were created on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
	CreatedOnExpression string `json:"createdOnExpression,omitempty"`
	// Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	CreatedAfter *string `json:"createdAfter,omitempty"`
	// Restrict to tasks that were created after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
	CreatedAfterExpression string `json:"createdAfterExpression,omitempty"`
	// Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.13/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd' 'HH:mm:ss`, e.g., `2013-01-23 14:42:45`.
	CreatedBefore *string `json:"createdBefore,omitempty"`
	// Restrict to tasks that were created before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
	CreatedBeforeExpression string `json:"createdBeforeExpression,omitempty"`
	// Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`.
	DelegationState string `json:"delegationState,omitempty"`
	// Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example `developers,support,sales`.
	CandidateGroups []string `json:"candidateGroups,omitempty"`
	// Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to `java.util.List` of Strings.
	CandidateGroupsExpression string `json:"candidateGroupsExpression,omitempty"`
	// Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior.
	WithCandidateGroups *bool `json:"withCandidateGroups,omitempty"`
	// Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior.
	WithoutCandidateGroups *bool `json:"withoutCandidateGroups,omitempty"`
	// Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior.
	WithCandidateUsers *bool `json:"withCandidateUsers,omitempty"`
	// Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior.
	WithoutCandidateUsers *bool `json:"withoutCandidateUsers,omitempty"`
	// Only include active tasks. Value may only be `true`, as `false` is the default behavior.
	Active *bool `json:"active,omitempty"`
	// Only include suspended tasks. Value may only be `true`, as `false` is the default behavior.
	Suspended *bool `json:"suspended,omitempty"`
	// A JSON array to only include tasks that have variables with certain values. The array consists of JSON objects with three properties `name`, `operator` and `value`. `name` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. `value` may be of type `String`, `Number` or `Boolean`.  Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
	TaskVariables []VariableQueryParameterDto `json:"taskVariables,omitempty"`
	// A JSON array to only include tasks that belong to a process instance with variables with certain values. The array consists of JSON objects with three properties `name`, `operator` and `value`. `name` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. `value` may be of type `String`, `Number` or `Boolean`.  Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
	ProcessVariables []VariableQueryParameterDto `json:"processVariables,omitempty"`
	// A JSON array to only include tasks that belong to a case instance with variables with certain values. The array consists of JSON objects with three properties `name`, `operator` and `value`. `name` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. `value` may be of type `String`, `Number` or `Boolean`.  Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
	CaseInstanceVariables []VariableQueryParameterDto `json:"caseInstanceVariables,omitempty"`
	// Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal.
	VariableNamesIgnoreCase *bool `json:"variableNamesIgnoreCase,omitempty"`
	// Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal.
	VariableValuesIgnoreCase *bool `json:"variableValuesIgnoreCase,omitempty"`
	// Restrict query to all tasks that are sub tasks of the given task. Takes a task id.
	ParentTaskId string `json:"parentTaskId,omitempty"`
	// A JSON array of nested task queries with OR semantics. A task matches a nested query if it fulfills *at least one* of the query's predicates. With multiple nested queries, a task must fulfill at least one predicate of *each* query ([Conjunctive Normal Form](https://en.wikipedia.org/wiki/Conjunctive_normal_form)).  All task query properties can be used except for: `sorting`, `withCandidateGroups`, `withoutCandidateGroups`, `withCandidateUsers`, `withoutCandidateUsers`  See the [User guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/process-engine-api/#or-queries) for more information about OR queries.
	OrQueries []TaskQueryDto `json:"orQueries,omitempty"`
	// Apply sorting of the result
	Sorting []TaskQueryDtoSorting `json:"sorting,omitempty"`
}

TaskQueryDto A Task query which defines a group of Tasks.

type TaskQueryDtoSorting

type TaskQueryDtoSorting struct {
	// Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.
	SortBy string `json:"sortBy,omitempty"`
	// Sort the results in a given order. Values may be `asc` for ascending order or `desc` for descending order. Must be used in conjunction with the sortBy parameter.
	SortOrder  string                     `json:"sortOrder,omitempty"`
	Parameters SortTaskQueryParametersDto `json:"parameters,omitempty"`
}

TaskQueryDtoSorting struct for TaskQueryDtoSorting

type TaskVariableApiService

type TaskVariableApiService service

TaskVariableApiService TaskVariableApi service

func (*TaskVariableApiService) DeleteTaskVariable

func (a *TaskVariableApiService) DeleteTaskVariable(ctx _context.Context, id string, varName string) (*_nethttp.Response, error)

DeleteTaskVariable Method for DeleteTaskVariable Removes a variable that is visible to a task. A variable is visible to a task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to delete the variable from.
  • @param varName The name of the variable to be removed.

func (*TaskVariableApiService) GetTaskVariable

func (a *TaskVariableApiService) GetTaskVariable(ctx _context.Context, id string, varName string, localVarOptionals *GetTaskVariableOpts) (VariableValueDto, *_nethttp.Response, error)

GetTaskVariable Method for GetTaskVariable Retrieves a variable from the context of a given task. The variable must be visible from the task. It is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the variable from.
  • @param varName The name of the variable to get.
  • @param optional nil or *GetTaskVariableOpts - Optional Parameters:
  • @param "DeserializeValue" (optional.Bool) - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine.

@return VariableValueDto

func (*TaskVariableApiService) GetTaskVariableBinary

func (a *TaskVariableApiService) GetTaskVariableBinary(ctx _context.Context, id string, varName string) (*os.File, *_nethttp.Response, error)

GetTaskVariableBinary Method for GetTaskVariableBinary Retrieves a binary variable from the context of a given task. Applicable for byte array and file variables. The variable must be visible from the task. It is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the variable for.
  • @param varName The name of the variable to retrieve.

@return *os.File

func (*TaskVariableApiService) GetTaskVariables

func (a *TaskVariableApiService) GetTaskVariables(ctx _context.Context, id string, localVarOptionals *GetTaskVariablesOpts) (map[string]VariableValueDto, *_nethttp.Response, error)

GetTaskVariables Method for GetTaskVariables Retrieves all variables visible from the task. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the variables from.
  • @param optional nil or *GetTaskVariablesOpts - Optional Parameters:
  • @param "DeserializeValue" (optional.Bool) - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine.

@return map[string]VariableValueDto

func (*TaskVariableApiService) ModifyTaskVariables

func (a *TaskVariableApiService) ModifyTaskVariables(ctx _context.Context, id string, localVarOptionals *ModifyTaskVariablesOpts) (*_nethttp.Response, error)

ModifyTaskVariables Method for ModifyTaskVariables Updates or deletes the variables visible from the task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to set variables for.
  • @param optional nil or *ModifyTaskVariablesOpts - Optional Parameters:
  • @param "PatchVariablesDto" (optional.Interface of PatchVariablesDto) -

func (*TaskVariableApiService) PutTaskVariable

func (a *TaskVariableApiService) PutTaskVariable(ctx _context.Context, id string, varName string, localVarOptionals *PutTaskVariableOpts) (*_nethttp.Response, error)

PutTaskVariable Method for PutTaskVariable Updates a process variable that is visible from the Task scope. A variable is visible from the task if it is a local task variable, or declared in a parent scope of the task. See the documentation on [variable scopes and visibility](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables#variable-scopes-and-variable-visibility). **Note**: If a variable doesn't exist, the variable is created in the top-most scope visible from the task.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to set the variable for.
  • @param varName The name of the variable to set.
  • @param optional nil or *PutTaskVariableOpts - Optional Parameters:
  • @param "VariableValueDto" (optional.Interface of VariableValueDto) -

func (*TaskVariableApiService) SetBinaryTaskVariable

func (a *TaskVariableApiService) SetBinaryTaskVariable(ctx _context.Context, id string, varName string, localVarOptionals *SetBinaryTaskVariableOpts) (*_nethttp.Response, error)

SetBinaryTaskVariable Method for SetBinaryTaskVariable Sets the serialized value for a binary variable or the binary value for a file variable visible from the task. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables/).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the task to retrieve the variable for.
  • @param varName The name of the variable to retrieve.
  • @param optional nil or *SetBinaryTaskVariableOpts - Optional Parameters:
  • @param "Data" (optional.Interface of *os.File) - The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory.
  • @param "ValueType" (optional.String) - The name of the variable type. Either Bytes for a byte array variable or File for a file variable.

type ThrowSignalOpts

type ThrowSignalOpts struct {
	SignalDto optional.Interface
}

ThrowSignalOpts Optional parameters for the method 'ThrowSignal'

type TransitionInstanceDto

type TransitionInstanceDto struct {
	// The id of the transition instance.
	Id string `json:"id,omitempty"`
	// The id of the parent activity instance, for example a sub process instance.
	ParentActivityInstanceId string `json:"parentActivityInstanceId,omitempty"`
	// The id of the activity that this instance enters (asyncBefore job) or leaves (asyncAfter job)
	ActivityId string `json:"activityId,omitempty"`
	// The name of the activity that this instance enters (asyncBefore job) or leaves (asyncAfter job)
	ActivityName string `json:"activityName,omitempty"`
	// The type of the activity that this instance enters (asyncBefore job) or leaves (asyncAfter job)
	ActivityType string `json:"activityType,omitempty"`
	// The id of the process instance this instance is part of.
	ProcessInstanceId string `json:"processInstanceId,omitempty"`
	// The id of the process definition.
	ProcessDefinitionId string `json:"processDefinitionId,omitempty"`
	// The execution id.
	ExecutionId string `json:"executionId,omitempty"`
	// A list of incident ids.
	IncidentIds []string `json:"incidentIds,omitempty"`
	// A list of JSON objects containing incident specific properties: * `id`: the id of the incident * `activityId`: the activity id in which the incident occurred
	Incidents []ActivityInstanceIncidentDto `json:"incidents,omitempty"`
}

TransitionInstanceDto A JSON object corresponding to the Activity Instance tree of the given process instance.

type TriggerVariableValueDto

type TriggerVariableValueDto struct {
	// Indicates whether the variable should be a local variable or not. If set to true, the variable becomes a local variable of the execution entering the target activity.
	Local *bool `json:"local,omitempty"`
	// The variable's value. Value differs depending on the variable's type and on the deserializeValues parameter.
	Value string `json:"value,omitempty"`
	// The value type of the variable.
	Type string `json:"type,omitempty"`
	// A JSON object containing additional, value-type-dependent properties. For serialized variables of type Object, the following properties can be provided:  * `objectTypeName`: A string representation of the object's type name. * `serializationDataFormat`: The serialization format used to store the variable.  For serialized variables of type File, the following properties can be provided:  * `filename`: The name of the file. This is not the variable name but the name that will be used when downloading the file again. * `mimetype`: The MIME type of the file that is being uploaded. * `encoding`: The encoding of the file that is being uploaded.
	ValueInfo map[string]interface{} `json:"valueInfo,omitempty"`
}

TriggerVariableValueDto struct for TriggerVariableValueDto

type TriggerVariableValueDtoAllOf

type TriggerVariableValueDtoAllOf struct {
	// Indicates whether the variable should be a local variable or not. If set to true, the variable becomes a local variable of the execution entering the target activity.
	Local *bool `json:"local,omitempty"`
}

TriggerVariableValueDtoAllOf struct for TriggerVariableValueDtoAllOf

type UpdateHistoryTimeToLiveByProcessDefinitionIdOpts

type UpdateHistoryTimeToLiveByProcessDefinitionIdOpts struct {
	HistoryTimeToLiveDto optional.Interface
}

UpdateHistoryTimeToLiveByProcessDefinitionIdOpts Optional parameters for the method 'UpdateHistoryTimeToLiveByProcessDefinitionId'

type UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdOpts

type UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdOpts struct {
	HistoryTimeToLiveDto optional.Interface
}

UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdOpts Optional parameters for the method 'UpdateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId'

type UpdateHistoryTimeToLiveByProcessDefinitionKeyOpts

type UpdateHistoryTimeToLiveByProcessDefinitionKeyOpts struct {
	HistoryTimeToLiveDto optional.Interface
}

UpdateHistoryTimeToLiveByProcessDefinitionKeyOpts Optional parameters for the method 'UpdateHistoryTimeToLiveByProcessDefinitionKey'

type UpdateProcessDefinitionSuspensionStateByIdOpts

type UpdateProcessDefinitionSuspensionStateByIdOpts struct {
	ProcessDefinitionSuspensionStateDto optional.Interface
}

UpdateProcessDefinitionSuspensionStateByIdOpts Optional parameters for the method 'UpdateProcessDefinitionSuspensionStateById'

type UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdOpts

type UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdOpts struct {
	ProcessDefinitionSuspensionStateDto optional.Interface
}

UpdateProcessDefinitionSuspensionStateByKeyAndTenantIdOpts Optional parameters for the method 'UpdateProcessDefinitionSuspensionStateByKeyAndTenantId'

type UpdateProcessDefinitionSuspensionStateByKeyOpts

type UpdateProcessDefinitionSuspensionStateByKeyOpts struct {
	ProcessDefinitionSuspensionStateDto optional.Interface
}

UpdateProcessDefinitionSuspensionStateByKeyOpts Optional parameters for the method 'UpdateProcessDefinitionSuspensionStateByKey'

type UpdateProcessDefinitionSuspensionStateOpts

type UpdateProcessDefinitionSuspensionStateOpts struct {
	ProcessDefinitionSuspensionStateDto optional.Interface
}

UpdateProcessDefinitionSuspensionStateOpts Optional parameters for the method 'UpdateProcessDefinitionSuspensionState'

type UpdateSuspensionStateAsyncOperationOpts

type UpdateSuspensionStateAsyncOperationOpts struct {
	ProcessInstanceSuspensionStateAsyncDto optional.Interface
}

UpdateSuspensionStateAsyncOperationOpts Optional parameters for the method 'UpdateSuspensionStateAsyncOperation'

type UpdateSuspensionStateByIdOpts

type UpdateSuspensionStateByIdOpts struct {
	SuspensionStateDto optional.Interface
}

UpdateSuspensionStateByIdOpts Optional parameters for the method 'UpdateSuspensionStateById'

type UpdateSuspensionStateOpts

type UpdateSuspensionStateOpts struct {
	ProcessInstanceSuspensionStateDto optional.Interface
}

UpdateSuspensionStateOpts Optional parameters for the method 'UpdateSuspensionState'

type UpdateTaskOpts

type UpdateTaskOpts struct {
	TaskDto optional.Interface
}

UpdateTaskOpts Optional parameters for the method 'UpdateTask'

type UserIdDto

type UserIdDto struct {
	// The id of the user that the current action refers to.
	UserId string `json:"userId,omitempty"`
}

UserIdDto struct for UserIdDto

type VariableQueryParameterDto

type VariableQueryParameterDto struct {
	// The variable value, could be of type boolean, string or number
	Value string `json:"value,omitempty"`
	// Comparison operator to be used
	Operator string `json:"operator,omitempty"`
}

VariableQueryParameterDto struct for VariableQueryParameterDto

type VariableValueDto

type VariableValueDto struct {
	// The variable's value. Value differs depending on the variable's type and on the deserializeValues parameter.
	Value string `json:"value,omitempty"`
	// The value type of the variable.
	Type string `json:"type,omitempty"`
	// A JSON object containing additional, value-type-dependent properties. For serialized variables of type Object, the following properties can be provided:  * `objectTypeName`: A string representation of the object's type name. * `serializationDataFormat`: The serialization format used to store the variable.  For serialized variables of type File, the following properties can be provided:  * `filename`: The name of the file. This is not the variable name but the name that will be used when downloading the file again. * `mimetype`: The MIME type of the file that is being uploaded. * `encoding`: The encoding of the file that is being uploaded.
	ValueInfo map[string]interface{} `json:"valueInfo,omitempty"`
}

VariableValueDto struct for VariableValueDto

type VersionApiService

type VersionApiService service

VersionApiService VersionApi service

func (*VersionApiService) GetRestAPIVersion

func (a *VersionApiService) GetRestAPIVersion(ctx _context.Context) (VersionDto, *_nethttp.Response, error)

GetRestAPIVersion Method for GetRestAPIVersion Retrieves the version of the Rest API.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return VersionDto

type VersionDto

type VersionDto struct {
	// The version of the Rest API.
	Version string `json:"version,omitempty"`
}

VersionDto struct for VersionDto

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL