MGCLatticeWorkflowActionRequestContract

Data contract for workflow work item action requests: the work item (WorkItemRecId or WorkflowCorrelationId), the acting user (ActingUserId), Comment, and DelegateToUserId for a delegation.

Methods

new

Initializes a new instance of the MGCLatticeWorkflowActionRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeWorkflowActionRequestContract class.

• Visibility: public
• Returns: MGCLatticeWorkflowActionRequestContract A new MGCLatticeWorkflowActionRequestContract instance.

No parameters.

parmCorrelationId

Gets or sets the correlation identifier for tracing the request across systems.

• Visibility: public
• Returns: Guid The CorrelationId value.

Name	Type	Optional	Description
_correlationId	Guid	Yes	The CorrelationId value.

parmRequestId

Gets or sets the unique request identifier for idempotency.

• Visibility: public
• Returns: Guid The RequestId value.

Name	Type	Optional	Description
_requestId	Guid	Yes	The RequestId value.

parmLegalEntityId

Gets or sets the legal entity (company) in which to execute the operation.

• Visibility: public
• Returns: DataAreaId The LegalEntityId value.

Name	Type	Optional	Description
_legalEntityId	DataAreaId	Yes	The LegalEntityId value.

parmUserContext

Gets or sets the caller's user context. Informational: the user the work-item action is taken as is ActingUserId.

• Visibility: public
• Returns: UserId The UserContext value.

Name	Type	Optional	Description
_userContext	UserId	Yes	The UserContext value.

parmActingUserId

Gets or sets the user the work-item action is taken as. Required. It must be the assignee of the work item: the action runs as that user (the workflow history records it), and a work item assigned to anyone else is refused.

• Visibility: public
• Returns: UserId The ActingUserId value.

Name	Type	Optional	Description
_actingUserId	UserId	Yes	The ActingUserId value.

parmWorkItemRecId

Gets or sets the workflow work item record identifier.

• Visibility: public
• Returns: int64 The WorkItemRecId value.

Name	Type	Optional	Description
_workItemRecId	int64	Yes	The WorkItemRecId value.

parmWorkflowCorrelationId

Gets or sets the workflow correlation identifier (the DocumentId submitToWorkflow returns) used to resolve the pending work item assigned to ActingUserId when WorkItemRecId is not supplied.

• Visibility: public
• Returns: Guid The WorkflowCorrelationId value.

Name	Type	Optional	Description
_workflowCorrelationId	Guid	Yes	The WorkflowCorrelationId value.

parmComment

Gets or sets the comment or note associated with the request.

• Visibility: public
• Returns: str The Comment value.

Name	Type	Optional	Description
_comment	str	Yes	The Comment value.

parmDelegateToUserId

Gets or sets the user the work item is delegated to. Required by delegateWorkItem; must be an enabled user other than the acting user. Not used by approve and reject.

• Visibility: public
• Returns: UserId The DelegateToUserId value.

Name	Type	Optional	Description
_delegateToUserId	UserId	Yes	The DelegateToUserId value.

parmPreviewMode

Gets or sets whether the request runs in preview mode. This operation does not implement a preview: a request with PreviewMode set to true is refused with PreviewUnsupported before anything is created or posted.

• Visibility: public
• Returns: boolean The current preview flag.

Name	Type	Optional	Description
_previewMode	boolean	Yes	The preview flag to set.