AssetFaceCorrectionDto

Endpoints · All schemas

Field	Required	Description
box	No	Move or resize the face, in the displayed (edited) image
expectedPersonId	No	The person the face was assigned to when the correction was made (null when unassigned)
expectedRevision	Yes	The face revision this correction was made against; a different current revision is refused with 409
expectedSourceRevision	No	The face source revision (GET /faces/source) the coordinates were drawn on. When the image, its orientation or its edits changed since, the request is refused with 409
hidden	No	Hide the face, or show a hidden face again
personId	No	Assign the face to this person, or null to unassign it

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: AssetFaceBoxDto

{
  "properties": {
    "box": {
      "$ref": "#/components/schemas/AssetFaceBoxDto",
      "description": "Move or resize the face, in the displayed (edited) image"
    },
    "expectedPersonId": {
      "description": "The person the face was assigned to when the correction was made (null when unassigned)",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "expectedRevision": {
      "description": "The face revision this correction was made against; a different current revision is refused with 409",
      "type": "string"
    },
    "expectedSourceRevision": {
      "description": "The face source revision (GET /faces/source) the coordinates were drawn on. When the image, its orientation or its edits changed since, the request is refused with 409",
      "type": "string"
    },
    "hidden": {
      "description": "Hide the face, or show a hidden face again",
      "type": "boolean"
    },
    "personId": {
      "description": "Assign the face to this person, or null to unassign it",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  },
  "required": [
    "expectedRevision"
  ],
  "type": "object"
}