terriajs/wwwroot/schema/MagdaCatalogItem.json

Geospatial data visualization platform.

{
  "type": "object",
  "defaultProperties": [
    "name",
    "type",
    "url"
  ],
  "properties": {
    "distributionId": {
      "type": "string",
      "title": "Distribution ID",
      "description": "The ID of the MAGDA distribution referred to by this catalog item.  Either this property\ror {@see MagdaCatalogItem#datasetId} must be specified.  If {@see MagdaCatalogItem#datasetId} is\rspecified too, and this distribution is not found, _any_ supported distribution may be used instead,\rdepending on the value of {@see MagdaCatalogItem#allowAnyDistributionIfDistributionIdNotFound}."
    },
    "datasetId": {
      "type": "string",
      "title": "Dataset ID",
      "description": "The ID of the MAGDA dataset referred to by this catalog item.  Either this property\ris {@see MagdaCatalogItem#distributionId} must be specified.  The first distribution of a supported type\rin this dataset will be used."
    },
    "allowAnyDistributionIfDistributionIdNotFound": {
      "type": "boolean",
      "title": "Allow any distribution if distribution ID not found",
      "description": "A value indicating whether any supported distribution may be used if both {@see MagdaCatalogItem#datasetId} and\r{@see MagdaCatalogItem#distributionId} are specified and the {@see MagdaCatalogItem#distributionId} is not found.",
      "format": "checkbox"
    },
    "allowWms": {
      "type": "boolean",
      "title": "Allow WMS",
      "description": "A value indicating whether this may be a WMS distribution.",
      "format": "checkbox"
    },
    "allowWfs": {
      "type": "boolean",
      "title": "Allow WFS",
      "description": "A value indicating whether this may be a WFS distribution.",
      "format": "checkbox"
    },
    "allowKml": {
      "type": "boolean",
      "title": "Allow KML",
      "description": "A value indicating whether this may be a KML distribution.",
      "format": "checkbox"
    },
    "allowCsv": {
      "type": "boolean",
      "title": "Allow CSV",
      "description": "A value indicating whether this may be a CSV distribution.",
      "format": "checkbox"
    },
    "allowEsriMapServer": {
      "type": "boolean",
      "title": "Allow esri map server",
      "description": "A value indicating whether this may be an Esri MapServer distribution.",
      "format": "checkbox"
    },
    "allowEsriFeatureServer": {
      "type": "boolean",
      "title": "Allow esri feature server",
      "description": "A value indicating whether this may be an Esri FeatureServer distribution.",
      "format": "checkbox"
    },
    "allowGeoJson": {
      "type": "boolean",
      "title": "Allow geo JSON",
      "description": "A value indicating whether this may be a GeoJSON distribution.",
      "format": "checkbox"
    },
    "allowCzml": {
      "type": "boolean",
      "title": "Allow CZML",
      "description": "A value indicating whether this may be a CZML distribution.",
      "format": "checkbox"
    },
    "itemProperties": {
      "type": "object",
      "title": "Item properties",
      "description": "A hash of properties that will be set on the item created from the MAGDA distribution.\rFor example, { \"treat404AsError\": false }"
    }
  },
  "allOf": [
    {
      "$ref": "CatalogItem.json"
    },
    {
      "$ref": "CatalogMember.json"
    }
  ]
}