.. _ReviewRequest:

Review Request
==============

A review rqeuest object holds all the information required to ask reviewers to start their reviews of `ZAAKINFORMATIEOBJECT`en or `ZAAKEIGENSCHAP`pen.
The review request object was previously handled by KOWNSL which as of March 27th of 2024 has been deprecated in favor of a hybrid
solution between the OBJECTS API and the ZAC itself.
The review request is linked to a :ref:`Zaak` and :ref:`Review`.
Any ZAAK can have any number of review requests. Current implementation of a review objecttype:

.. code-block:: json

    {
        "type":"object",
        "$defs":{
            "user":{
                "type":"object",
                "title":"user",
                "required":[
                    "username",
                    "firstName",
                    "fullName",
                    "lastName",
                    "email"
                ],
                "properties":{
                    "email":{
                    "type":"string"
                    },
                    "fullName":{
                    "type":"string"
                    },
                    "lastName":{
                    "type":"string"
                    },
                    "username":{
                    "type":"string"
                    },
                    "firstName":{
                    "type":"string"
                    }
                }
            },
            "group":{
                "type":"object",
                "title":"group",
                "required":[
                    "name",
                    "fullName"
                ],
                "properties":{
                    "name":{
                    "type":"string"
                    },
                    "fullName":{
                    "type":"string"
                    }
                }
            },
            "assignedUser":{
                "type":"object",
                "title":"AssignedUser",
                "required":[
                    "deadline",
                    "emailNotification",
                    "userAssignees",
                    "groupAssignees"
                ],
                "properties":{
                    "deadline":{
                    "type":"string"
                    },
                    "userAssignees":{
                    "type":"array",
                    "items":{
                        "$ref":"#/$defs/user"
                    }
                    },
                    "groupAssignees":{
                    "type":"array",
                    "items":{
                        "$ref":"#/$defs/group"
                    }
                    },
                    "emailNotification":{
                    "type":"boolean"
                    }
                }
            }
        },
        "title":"ReviewRequest",
        "required":[
            "assignedUsers",
            "created",
            "documents",
            "id",
            "isBeingReconfigured",
            "locked",
            "lockReason",
            "metadata",
            "numReviewsGivenBeforeChange",
            "requester",
            "reviewType",
            "toelichting",
            "userDeadlines",
            "zaak",
            "zaakeigenschappen"
        ],
        "properties":{
            "id":{
                "type":"string"
            },
            "zaak":{
                "type":"string"
            },
            "locked":{
                "type":"boolean"
            },
            "created":{
                "type":"string"
            },
            "metadata":{
                "type":"object",
                "title":"Metadata",
                "properties":{
                    "taskDefinitionId":{
                    "type":"string"
                    },
                    "processInstanceId":{
                    "type":"string"
                    }
                }
            },
            "documents":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "requester":{
                "$ref":"#/$defs/user"
            },
            "lockReason":{
                "type":"string"
            },
            "reviewType":{
                "type":"string"
            },
            "toelichting":{
                "type":"string"
            },
            "assignedUsers":{
                "type":"array",
                "items":{
                    "$ref":"#/$defs/assignedUser"
                }
            },
            "userDeadlines":{
                "type":"object"
            },
            "zaakeigenschappen":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "isBeingReconfigured":{
                "type":"boolean"
            },
            "numReviewsGivenBeforeChange":{
                "type":"integer"
            }
        }
    }