API Docs / Schemas / DocumentRequestStepConfigDto

DocumentRequestStepConfigDto

Configuration for DocumentRequest workflow steps.
Used for both workflow template definition and task workflow step instance customization.

Properties

Name Type Description
title*string

The title for the document request to create.
Describes what documents are being requested from the client.

The title for the document request to create.
Describes what documents are being requested from the client.

descriptionstring

Optional description providing details about what documents are needed.

Optional description providing details about what documents are needed.

deadlineDaysFromExecutioninteger

Number of days from step execution to set as the client-facing deadline.
For example, 14 means the client has 14 days from when the step runs.
Null means no deadline is set on the document request.

Number of days from step execution to set as the client-facing deadline.
For example, 14 means the client has 14 days from when the step runs.
Null means no deadline is set on the document request.

notifyUserCodestring

Code of the user to notify when the client submits a response.
Defaults to the step's assigned user at execution time. Only set this
to override the default — most workflows should leave it null.

Code of the user to notify when the client submits a response.
Defaults to the step's assigned user at execution time. Only set this
to override the default — most workflows should leave it null.

JSON Example

{
  "title": "string",
  "description": "string",
  "deadlineDaysFromExecution": 1,
  "notifyUserCode": "string"
}

Contained in Schemas