Hippomundo Enterprise API
Schemas

BreedingTreeNode

Response and request schema

Schema

object or null

Ancestor node, at most three generations above the subject. Missing or cyclic parents and the parents of depth-limit leaves are null.

Additional properties: false.

FieldTypeDescription
approved_forarray of PedigreeStudbookRef · required
birth_yearBirthYear or null · required

Four-digit year derived from the recorded birth date. Null when no year is available; an exact month and day are never exposed.

Minimum: 1000. Maximum: 9999.

colourstring or null · required
damBreedingTreeNode or null · required

Ancestor node, at most three generations above the subject. Missing or cyclic parents and the parents of depth-limit leaves are null.

Additional properties: false.

idinteger (int64) · required

Minimum: 1.

namestring · required

Minimum length: 1.

sexstring or null · required
sireBreedingTreeNode or null · required

Ancestor node, at most three generations above the subject. Missing or cyclic parents and the parents of depth-limit leaves are null.

Additional properties: false.

studbookNullablePedigreeStudbookRef or null · required

Additional properties: false.

Related schemas: PedigreeStudbookRef, BirthYear, BreedingTreeNode, NullablePedigreeStudbookRef

Complete OpenAPI definition
{
  "additionalProperties": false,
  "description": "Ancestor node, at most three generations above the subject. Missing or cyclic parents and the parents of depth-limit leaves are null.",
  "nullable": true,
  "properties": {
    "approved_for": {
      "items": {
        "$ref": "#/components/schemas/PedigreeStudbookRef"
      },
      "type": "array"
    },
    "birth_year": {
      "$ref": "#/components/schemas/BirthYear"
    },
    "colour": {
      "nullable": true,
      "type": "string"
    },
    "dam": {
      "$ref": "#/components/schemas/BreedingTreeNode"
    },
    "id": {
      "format": "int64",
      "minimum": 1,
      "type": "integer"
    },
    "name": {
      "minLength": 1,
      "type": "string"
    },
    "sex": {
      "nullable": true,
      "type": "string"
    },
    "sire": {
      "$ref": "#/components/schemas/BreedingTreeNode"
    },
    "studbook": {
      "$ref": "#/components/schemas/NullablePedigreeStudbookRef"
    }
  },
  "required": [
    "id",
    "name",
    "birth_year",
    "sex",
    "colour",
    "studbook",
    "approved_for",
    "sire",
    "dam"
  ],
  "type": "object"
}