Skip to main content

Workflow API DTO Catalog

Audience​

Developers, frontend engineers, QA, support, architects and implementation partners.

Summary​

The application source declares 14 Workflow input/output records: seven request records and seven response records. Anonymous objects, persistence entities and shared service-information contracts are not counted as Workflow DTO declarations.

Reference Content​

The tables below inventory every Workflow request and response record declared in the application DTO source.

Request records​

DTOPurposeDirectionVerified validationSource path
WorkflowConditionInputDefine one stage conditionNested requestBlank field removed; operator/value otherwise permissivemicroservices/src/workflow-service/Application/Dtos.cs
WorkflowStepInputDefine one authored stepNested requestApprover type required/parsed; step type and mode default; limited structural checksmicroservices/src/workflow-service/Application/Dtos.cs
CreateWorkflowDefinitionInputCreate definition and initial stepsRequestKey/name required; tenant/key uniqueness; nested parsingmicroservices/src/workflow-service/Application/Dtos.cs
UpdateWorkflowDefinitionInputUpdate definition and optional draft stepsRequestOptional fields; nested parsing when steps suppliedmicroservices/src/workflow-service/Application/Dtos.cs
StartWorkflowInputStart a published WorkflowRequestDefinition identifier or key required; published version requiredmicroservices/src/workflow-service/Application/Dtos.cs
TaskDecisionInputCarry optional decision commentRequestEntire body optional for approval/rejection; no comment requirementmicroservices/src/workflow-service/Application/Dtos.cs
DelegateTaskInputCarry destination and optional commentRequestDestination must be nonblankmicroservices/src/workflow-service/Application/Dtos.cs

Response records​

DTOPurposeDirectionConstructionSource path
WorkflowConditionDtoCondition projectionNested responseDomain mappingmicroservices/src/workflow-service/Application/Dtos.cs
WorkflowStepDtoStep projectionNested responseDomain mappingmicroservices/src/workflow-service/Application/Dtos.cs
WorkflowVersionDtoVersion with ordered steps/conditionsNested responseDomain mappingmicroservices/src/workflow-service/Application/Dtos.cs
WorkflowDefinitionDtoFull definition graphResponseAggregate mappingmicroservices/src/workflow-service/Application/Dtos.cs
WorkflowDefinitionSummaryDtoDefinition list rowResponseAggregate summary mappingmicroservices/src/workflow-service/Application/Dtos.cs
WorkflowTaskDtoTask/worklist projectionResponse/nested responseEntity mapping with optional Workflow keymicroservices/src/workflow-service/Application/Dtos.cs
WorkflowInstanceDtoInstance with ordered tasksResponseAggregate mappingmicroservices/src/workflow-service/Application/Dtos.cs

Non-DTO shapes​

Health summary, message errors and outbox metadata use anonymous objects. Audit and timeline return persistence entities. Framework health and shared service information use framework/shared contracts.

Requires Confirmation​

DTO evolution, nullability expectations, generated schema publication and separation of persistence diagnostic models require confirmation.

Source References​

  • microservices/src/workflow-service/Application/Dtos.cs
  • microservices/src/workflow-service/Application/Mappings.cs
  • microservices/src/workflow-service/Application/Commands/WorkflowDefinitionCommands.cs
  • microservices/src/workflow-service/Application/Commands/WorkflowInstanceCommands.cs

See Also​

Keywords​

Workflow API, approval endpoint, Workflow Service.

Revision Information​

  • Status: Draft
  • Last reviewed: 2026-07-20
  • Next review: 2026-10-20