MediaHealthCandidateDto

Endpoints · All schemas

Field	Required	Description
candidatePath	Yes	Candidate file path
checkedAt	Yes	string
checksumMatch	Yes	The candidate has exactly the checksum recorded for the original
checksums	Yes	The checksums the candidate matched, as measured
chosen	Yes	The reviewer chose this candidate for the finding
decodeValid	Yes	The candidate decoded successfully; null when not checked
evidence	Yes	object
healthId	Yes	Media health finding ID
id	Yes	Candidate ID
resolution	Yes	object
rootId	Yes	Search location the candidate was found in
rootKind	Yes	See definition below
status	Yes	See definition below
visualMatchScore	Yes	Visual match score from 0 to 1

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: MediaHealthChecksumDto, MediaHealthRootKind, MediaHealthStatus

{
  "properties": {
    "candidatePath": {
      "description": "Candidate file path",
      "type": "string"
    },
    "checkedAt": {
      "format": "date-time",
      "type": "string"
    },
    "checksumMatch": {
      "description": "The candidate has exactly the checksum recorded for the original",
      "type": "boolean"
    },
    "checksums": {
      "description": "The checksums the candidate matched, as measured",
      "items": {
        "$ref": "#/components/schemas/MediaHealthChecksumDto"
      },
      "type": "array"
    },
    "chosen": {
      "description": "The reviewer chose this candidate for the finding",
      "type": "boolean"
    },
    "decodeValid": {
      "description": "The candidate decoded successfully; null when not checked",
      "nullable": true,
      "type": "boolean"
    },
    "evidence": {
      "additionalProperties": {},
      "type": "object"
    },
    "healthId": {
      "description": "Media health finding ID",
      "format": "uuid",
      "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"
    },
    "id": {
      "description": "Candidate ID",
      "format": "uuid",
      "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"
    },
    "resolution": {
      "additionalProperties": {},
      "type": "object"
    },
    "rootId": {
      "description": "Search location the candidate was found in",
      "nullable": true,
      "type": "string"
    },
    "rootKind": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MediaHealthRootKind"
        }
      ],
      "nullable": true
    },
    "status": {
      "$ref": "#/components/schemas/MediaHealthStatus"
    },
    "visualMatchScore": {
      "description": "Visual match score from 0 to 1",
      "format": "double",
      "nullable": true,
      "type": "number"
    }
  },
  "required": [
    "candidatePath",
    "checkedAt",
    "checksumMatch",
    "checksums",
    "chosen",
    "decodeValid",
    "evidence",
    "healthId",
    "id",
    "resolution",
    "rootId",
    "rootKind",
    "status",
    "visualMatchScore"
  ],
  "type": "object"
}