API - SC WF Instances

Object Definition

Object Type	Page
Object ID	70337569
Object Name	QWEEG API - SC WF Instances
Source Table	QWEEG Workflow Instance
Read-only	Yes

API Definition

APIPublisher	smartApps
APIGroup	eagle
APIVersion	v1.0
EntitySetName	singleCompanyWorkflowInstances
EntityName	singleCompanyWorkflowInstance

Service Enabled Procedures

Name	Description
Cancel(WebServiceActionContext)	Cancels the workflow instance.
CompleteCurrentManualStep(WebServiceActionContext)	Completes the current manual step of the workflow instance.
OverrideCurrentStepCondition(WebServiceActionContext)	Overrides the current step condition of the workflow instance.
ProcessCurrentStep(WebServiceActionContext)	Starts the next step of the workflow instance again.
ProcessCurrentStepAgain(WebServiceActionContext)	Processes the current step of the workflow instance again.
SkipCurrentStep(WebServiceActionContext)	Skips the current step of the workflow instance.
StartFirstStep(WebServiceActionContext)	Starts the first step of the workflow instance.
StartNextStep(WebServiceActionContext)	Starts the next step of the workflow instance.
UpdateKPIs(WebServiceActionContext)	Updates the KPIs of the workflow instance.

Controls

Type	Name	Data Type	Read-only
Field	id	Guid	Yes
Field	number	Integer	Yes
Field	displayName	Text[100]	Yes
Field	status	Enum "QWEEG Workflow Instance Status"	Yes
Field	workflowId	Integer	Yes
Field	workflowSystemId	Guid	Yes
Field	workflowDate	Date	Yes
Field	startedAt	DateTime	Yes
Field	completedAt	DateTime	Yes
Field	active	Boolean	Yes
Field	actionRequiredReason	Enum "QWEEG Action Required Reason"	Yes
Field	currentStepNumber	Integer	Yes
Field	currentStepStatus	Enum "QWEEG Workflow Step Status"	Yes
Field	currentStepType	Enum "QWEEG Workflow Step Type"	Yes
Field	currentStepDescription	Text[100]	Yes
Field	errorMessage	Text	Yes
Field	startFromStepNumber	Integer	Yes
Field	lastModifiedDateTime	DateTime	Yes
Field	createdAt	DateTime	Yes
Sub page	KPIs		Yes
Sub page	Steps		Yes

This documentation is generated from Eagle v27.6