Skip to content

Seed

The Seed model represents the complete seed object returned by the Archive-It API. It includes all fields that the API provides, including read-only fields like id, created_date, and last_updated_date.


Show JSON schema:
{
  "additionalProperties": true,
  "description": "Model representing a complete Seed object from Archive-it API.\n\nThis model is used for API responses and contains all possible seed fields.\nUse this when receiving seed data from the API.",
  "properties": {
    "id": {
      "description": "Unique identifier for the seed",
      "title": "Id",
      "type": "integer"
    },
    "url": {
      "description": "URL of the seed",
      "title": "Url",
      "type": "string"
    },
    "collection": {
      "description": "Collection ID the seed belongs to",
      "title": "Collection",
      "type": "integer"
    },
    "crawl_definition": {
      "description": "Crawl definition ID the seed belongs to",
      "title": "Crawl Definition",
      "type": "integer"
    },
    "active": {
      "description": "Indicates if the seed is active",
      "title": "Active",
      "type": "boolean"
    },
    "deleted": {
      "description": "Indicates if the seed is deleted",
      "title": "Deleted",
      "type": "boolean"
    },
    "last_updated_date": {
      "description": "Date when the seed was last updated",
      "title": "Last Updated Date",
      "type": "string"
    },
    "canonical_url": {
      "description": "Canonical URL of the seed",
      "title": "Canonical Url",
      "type": "string"
    },
    "created_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "User who created the seed",
      "title": "Created By"
    },
    "created_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Date when the seed was created",
      "title": "Created Date"
    },
    "last_updated_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "User who last updated the seed",
      "title": "Last Updated By"
    },
    "publicly_visible": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Indicates if the seed is publicly visible",
      "title": "Publicly Visible"
    },
    "http_response_code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "HTTP response code",
      "title": "Http Response Code"
    },
    "valid": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Indicates if the seed is valid",
      "title": "Valid"
    },
    "seed_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Type of the seed",
      "title": "Seed Type"
    },
    "login_username": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Login username for the seed",
      "title": "Login Username"
    },
    "login_password": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Login password for the seed",
      "title": "Login Password"
    },
    "metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "description": "Metadata for the seed",
      "title": "Metadata"
    },
    "seed_groups": {
      "anyOf": [
        {
          "items": {},
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "description": "List of seed groups the seed belongs to",
      "title": "Seed Groups"
    }
  },
  "required": [
    "id",
    "url",
    "collection",
    "crawl_definition",
    "active",
    "deleted",
    "last_updated_date",
    "canonical_url",
    "created_by",
    "created_date",
    "last_updated_by",
    "publicly_visible",
    "http_response_code",
    "valid",
    "seed_type",
    "login_username",
    "login_password",
    "metadata",
    "seed_groups"
  ],
  "title": "Seed",
  "type": "object"
}

Config:

  • default: {'extra': 'allow'}

Fields:

  • id (int)
  • url (str)
  • collection (int)
  • crawl_definition (int)
  • active (bool)
  • deleted (bool)
  • last_updated_date (str)
  • canonical_url (str)
  • created_by (str | None)
  • created_date (str | None)
  • last_updated_by (str | None)
  • publicly_visible (bool | None)
  • http_response_code (int | None)
  • valid (bool | None)
  • seed_type (str | None)
  • login_username (str | None)
  • login_password (str | None)
  • metadata (dict | None)
  • seed_groups (list | None)

Validators:

  • block_forbidden_fields

Protected Fields

The following fields are read-only and cannot be set via user input:

  • id
  • created_by
  • created_date
  • last_updated_by
  • last_updated_date
  • canonical_url
  • http_response_code
  • last_checked_http_response_code
  • valid
  • seed_type
  • canonical_url

These fields are automatically populated by the Archive-It system and should not be modified directly.