Skip to main content

MGCLatticeWorkflowSubmitRequestContract

Data contract for workflow submission requests containing WorkflowTypeName, RecordRecId, TableName, and Comment.

Methods​

new​

Initializes a new instance of the MGCLatticeWorkflowSubmitRequestContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeWorkflowSubmitRequestContract class.

  • Visibility: public
  • Returns: MGCLatticeWorkflowSubmitRequestContract A new MGCLatticeWorkflowSubmitRequestContract 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.

parmWorkflowTypeName​

Gets or sets the workflow type name to activate.

  • Visibility: public
  • Returns: str The WorkflowTypeName value.
NameTypeOptionalDescription
_workflowTypeNamestrYesThe WorkflowTypeName value.

parmRecordRecId​

Gets or sets the record identifier to submit to workflow.

  • Visibility: public
  • Returns: int64 The RecordRecId value.
NameTypeOptionalDescription
_recordRecIdint64YesThe RecordRecId value.

parmTableName​

Gets or sets the table name containing the record to submit.

  • Visibility: public
  • Returns: str The TableName value.
NameTypeOptionalDescription
_tableNamestrYesThe TableName value.

parmDocumentNumber​

Gets or sets the optional natural-key document number used to resolve RecordRecId from TableName when the RecId is not supplied (for example a purchase requisition number for the PurchReqTable table). Resolution is implemented per supported table.

  • Visibility: public
  • Returns: str The DocumentNumber value.
NameTypeOptionalDescription
_documentNumberstrYesThe DocumentNumber 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.