# app.gainforest.gbif.dataset

> Published by [gainforest.earth](https://lexicon.garden/identity/did:plc:qoti4acfmc5wg6zzmtix6hse)

✓ This is the authoritative definition for this NSID.

## Description

Tracks a dataset registered with GBIF via the Registry API. Links a PDS organization to its GBIF dataset UUID, installation, and archive blob.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qoti4acfmc5wg6zzmtix6hse/app.gainforest.gbif.dataset)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qoti4acfmc5wg6zzmtix6hse/app.gainforest.gbif.dataset/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qoti4acfmc5wg6zzmtix6hse/app.gainforest.gbif.dataset/examples)

## Definitions

### `app.gainforest.gbif.dataset`

**Type**: `record`

A GBIF dataset registration record linking a PDS organization to its GBIF dataset UUID, installation, and archive blob.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `createdAt` | `string` (datetime) | Yes | Timestamp of record creation in the ATProto PDS |
| `archiveBlob` | `blob` | No | Blob reference to the DwC-A archive ZIP. Storing as a proper blob ref prevents PDS garbage collection. |
| `datasetTitle` | `string` | No | Human-readable dataset title |
| `archiveBlobCid` | `string` | No | CID of the most recently uploaded DwC-A blob |
| `gbifDatasetKey` | `string` | Yes | GBIF dataset UUID returned by POST /dataset |
| `gbifEndpointKey` | `integer` | No | GBIF endpoint integer key returned by POST /dataset/{key}/endpoint |
| `lastPublishedAt` | `string` (datetime) | No | When the archive was last published to GBIF |
| `organizationRef` | `string` (at-uri) | Yes | AT-URI of the organization info record this dataset belongs to |
| `gbifInstallationKey` | `string` | Yes | GBIF installation UUID used when creating the dataset |
| `lastCrawlFinishReason` | `string` | No | Result of last GBIF crawl (NORMAL, ABORT, etc.) |

## Raw Schema

```json
{
  "id": "app.gainforest.gbif.dataset",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "organizationRef",
          "gbifDatasetKey",
          "gbifInstallationKey",
          "createdAt"
        ],
        "properties": {
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "Timestamp of record creation in the ATProto PDS"
          },
          "archiveBlob": {
            "type": "blob",
            "accept": [
              "application/zip"
            ],
            "description": "Blob reference to the DwC-A archive ZIP. Storing as a proper blob ref prevents PDS garbage collection."
          },
          "datasetTitle": {
            "type": "string",
            "description": "Human-readable dataset title",
            "maxGraphemes": 256
          },
          "archiveBlobCid": {
            "type": "string",
            "description": "CID of the most recently uploaded DwC-A blob",
            "maxGraphemes": 128
          },
          "gbifDatasetKey": {
            "type": "string",
            "description": "GBIF dataset UUID returned by POST /dataset",
            "maxGraphemes": 64
          },
          "gbifEndpointKey": {
            "type": "integer",
            "description": "GBIF endpoint integer key returned by POST /dataset/{key}/endpoint"
          },
          "lastPublishedAt": {
            "type": "string",
            "format": "datetime",
            "description": "When the archive was last published to GBIF"
          },
          "organizationRef": {
            "type": "string",
            "format": "at-uri",
            "description": "AT-URI of the organization info record this dataset belongs to"
          },
          "gbifInstallationKey": {
            "type": "string",
            "description": "GBIF installation UUID used when creating the dataset",
            "maxGraphemes": 64
          },
          "lastCrawlFinishReason": {
            "type": "string",
            "description": "Result of last GBIF crawl (NORMAL, ABORT, etc.)",
            "maxGraphemes": 32
          }
        }
      },
      "description": "A GBIF dataset registration record linking a PDS organization to its GBIF dataset UUID, installation, and archive blob."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "Tracks a dataset registered with GBIF via the Registry API. Links a PDS organization to its GBIF dataset UUID, installation, and archive blob."
}
```