ReviewStageTO

A complex data type that represents a stage in a multi-staged review and approval process. Used with the Review, Commenting, and Approval building block, which is installed with the Managed Review & Approval Solution Accelerator.

For information about data that can be accessed using XPath Expressions, see Data items.

    Data items

    The data items that ReviewStageTO values contain.

    additionalMetadata

    A string value that represents additional information associated with the stage.

    assignTaskToInitiatorProcess

    A string value that represents the process that assigns the task to the initiator.

    assignTaskToParticipantProcess

    A string value that represents the process that assigns the task to a stage participant.

    disposition

    A string value that represents a custom status for the stage.

    duration

    An int value that represents the duration of the stage.

    durationUnit

    A string value that represents the unit of measurement for the stage duration.

    endDate

    A date value that specifies the end of the stage.

    id

    Internal use only.

    name

    A string value that represents the name of the stage.

    nonExpiringStage

    A boolean value that indicates whether this stage does not expire. If true, the stage is non-expiring.

    participants

    A list of ParticipantTO values that represent the stage participants.

    postProcessHookName

    A string value that represents the post-process hook for the stage.

    preProcessHookName

    A string value that represents the pre-process hook for the stage.

    reminders

    A list of ReminderTO values that represent reminders for the stage.

    reviewContext

    A ReviewContextTO value that the stage is associated with.

    signatureType

    A string value that represents a signature type for an approval stage.

    stageNo

    An int value that represents the stage’s number. Starts with 1.

    startDate

    A date value that specifies the start of the stage.

    status

    A string value that represents the status of the stage. The following values are valid:

    • PENDING

    • ONGOING

    • COMPLETED

    • EXPIRED

    • REVISED

    • REVOKED

    • APPROVED

    • REJECTED

    taskType

    A string value that represents the type of task.

    type

    A string value that represents the stage type. The following values are valid:

    • PARALLEL_REVIEW

    • SEQUENTIAL_REVIEW

    • PARALLEL_APPROVAL

    • SEQUENTIAL_APPROVAL

    waitForExpiry

    A boolean value that indicates whether to wait for the stage to complete its duration regardless of the status of the participants. If true, the process does not proceed to the next stage until the duration is complete.