com.tituslegaldesign.immigration.sourceSnapshot

287g-data.tituslegaldesign.com

Documentation

A point-in-time capture of an upstream source publication: ICE's participating-agencies workbook, a FOIA production, or a roster PDF. Agreement events reference the snapshot that justified them, so every published change traces back to an archived, content-addressed copy of the document it came from. Record key is a TID. Snapshots are never updated or deleted; a revised upstream file is a new snapshot.

main record

A point-in-time capture of an upstream source publication: ICE's participating-agencies workbook, a FOIA production, or a roster PDF. Agreement events reference the snapshot that justified them, so every published change traces back to an archived, content-addressed copy of the document it came from. Record key is a TID. Snapshots are never updated or deleted; a revised upstream file is a new snapshot.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

When this snapshot record was written.

file blob Optional

The captured artifact itself. Its CID pins the exact bytes. Omit only when the artifact cannot be redistributed.

maxSize: 50.0 MB
foiaRequestNumber string Optional

Agency-assigned FOIA tracking number, when publisher is 'foia'.

maxLength: 100 bytes
note string Optional

Context: retrieval anomalies, known upstream errors, processing caveats.

maxLength: 3000 bytes
publishedDate string Optional

The edition date the upstream publisher assigned, YYYY-MM-DD, where stated on the artifact itself.

maxLength: 10 bytes
publisher string Required

Who published the captured artifact. 'publisher' means this dataset's own maintainer produced it (e.g. a derived spreadsheet).

Known values: ice, foia, publisher, other
retrievedAt string datetime Required

When the artifact was retrieved and archived.

rowCount integer Optional

Number of agreement rows the artifact contained, where countable. Lets consumers detect silent upstream shrinkage.

minimum: 0
sourceUrl string uri Optional

Where the artifact was retrieved from, when it was published at a URL.

title string Optional

Human-readable description, e.g. 'ICE participating agencies workbook, 14 Aug 2026 edition'.

maxLength: 300 bytes
View raw schema 
{
  "description": "A point-in-time capture of an upstream source publication: ICE's participating-agencies workbook, a FOIA production, or a roster PDF. Agreement events reference the snapshot that justified them, so every published change traces back to an archived, content-addressed copy of the document it came from. Record key is a TID. Snapshots are never updated or deleted; a revised upstream file is a new snapshot.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "description": "When this snapshot record was written.",
        "format": "datetime",
        "type": "string"
      },
      "file": {
        "accept": [
          "application/pdf",
          "text/csv",
          "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
          "application/vnd.ms-excel"
        ],
        "description": "The captured artifact itself. Its CID pins the exact bytes. Omit only when the artifact cannot be redistributed.",
        "maxSize": 50000000,
        "type": "blob"
      },
      "foiaRequestNumber": {
        "description": "Agency-assigned FOIA tracking number, when publisher is 'foia'.",
        "maxLength": 100,
        "type": "string"
      },
      "note": {
        "description": "Context: retrieval anomalies, known upstream errors, processing caveats.",
        "maxLength": 3000,
        "type": "string"
      },
      "publishedDate": {
        "description": "The edition date the upstream publisher assigned, YYYY-MM-DD, where stated on the artifact itself.",
        "maxLength": 10,
        "type": "string"
      },
      "publisher": {
        "description": "Who published the captured artifact. 'publisher' means this dataset's own maintainer produced it (e.g. a derived spreadsheet).",
        "knownValues": [
          "ice",
          "foia",
          "publisher",
          "other"
        ],
        "type": "string"
      },
      "retrievedAt": {
        "description": "When the artifact was retrieved and archived.",
        "format": "datetime",
        "type": "string"
      },
      "rowCount": {
        "description": "Number of agreement rows the artifact contained, where countable. Lets consumers detect silent upstream shrinkage.",
        "minimum": 0,
        "type": "integer"
      },
      "sourceUrl": {
        "description": "Where the artifact was retrieved from, when it was published at a URL.",
        "format": "uri",
        "type": "string"
      },
      "title": {
        "description": "Human-readable description, e.g. 'ICE participating agencies workbook, 14 Aug 2026 edition'.",
        "maxLength": 300,
        "type": "string"
      }
    },
    "required": [
      "publisher",
      "retrievedAt",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@