Magidoc

ApprovalRound
Object

An approval round represents a collection of approval stages that must be completed for an action. Each round can contain multiple stages that execute sequentially.

Fields

#

_id

ID !
Non-null

Unique identifier for the approval round. Use this value as the roundId parameter in mutations like requestApprovals or insertApprovalStage.

actionId

ID !
Non-null

ID of the action this approval round belongs to.

workspace

ID !
Non-null

ID of the workspace this approval round belongs to.

templateId

ID

ID of the approval template this round was created from (if applicable).

name

String !
Non-null

Display name for this approval round (e.g., "Round 1", "Design Review").

sortIndex

Float

Display position, independent of creation and request chronology. Legacy rounds use their creation timestamp.

deleted

Boolean !
Non-null

Whether this approval round has been soft-deleted.

requestedBy

ID

User ID who requested approvals for this round.

isRequested

Boolean

Whether approvals have been requested from approvers.

moveToNextStage

MoveToNextStage

Strategy for moving to the next stage (allResponded, allApproved, or anyApproved). MoveToNextStage, not String — hive-common types it as the enum, the SDL already declares it with identical members, and production holds no values for this field.

requestHistory

[ApprovalRequestHistory !]!
Non-null

History of all approval requests for this round.

createdAt

Date !
Non-null

Timestamp when this round was created.

createdBy

ID !
Non-null

User ID who created this round.

startRoundIfNotAllApproved

Boolean

Whether to start the next round even if not all approvals were received.

lockApproversToTemplate

Boolean !
Non-null

When true, approvers for this round are locked to the template definition (if created from a template).

stages

[ID !]!
Non-null

Array of stage IDs belonging to this round. These IDs correspond to ApprovalStage._id values.

approvalStages

[ApprovalStage !]!
Non-null

Resolved approval stage objects for this round.

Usages

#

References

#