Skip to main content

MGCLatticeWorkflowRecallRequestContract

Data contract for workflow recall requests containing WorkflowCorrelationId and Comment.

Methods​

new​

Initializes a new instance of the MGCLatticeWorkflowRecallRequestContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeWorkflowRecallRequestContract class.

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

No parameters.

parmCorrelationId​

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

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

parmRequestId​

Gets or sets the unique request identifier for idempotency.

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

parmLegalEntityId​

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

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

parmUserContext​

Gets or sets the user context under which the operation executes.

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

parmWorkflowCorrelationId​

Gets or sets the workflow correlation identifier for the active workflow instance.

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

parmComment​

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

  • Visibility: public
  • Returns: str The Comment value.
NameTypeOptionalDescription
_commentstrYesThe Comment 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.
NameTypeOptionalDescription
_previewModebooleanYesThe preview flag to set.