Dataset Relationships

The metadata returned is represented as JSON. The topmost keys are as follows.

{
  "id": "3412b3e6-092f-4793-9c52-012dad48507e",		*1
  "acquisitionStartTime": "2018-06-28T15:58:19.024Z",
  "acquisitionEndTime": "2018-06-28T15:58:19.024Z",
  "userUuid": "533ec9b5-881a-46d2-8a2e-a5c623b20761",	*2
  "version": "cc208354-85c3-4277-9bc7-31161a4a9d30",	*2
  "extractedMetadata": null, 				*3
  "boundingGeoJson": {},				*4
  "footprintGeoJson": {},				*5
  "bands": [],						*6
  "products": [],					*7
  "tags": []						*8
}

1. UUID - unique dataset identifier
2. Internal UUID representing the owner of the dataset
3. Original vendor metadata converted from XML to JSON. The structure is very close to the original XML, but may not be identical. This element is null unless exclude_ancillary_metadata is set to false in the requesting methods.
4. Bounding GeoJson represents the full bounds of the scene.
5. Footprint GeoJson represents the non-blackfill bounds of the scene.
6. Bands is an array of all of the bands provided by the vendor.
7. Products is an array of all the products grouped by resolution except for CLOUD_MASK and UNUSABLE_DATA_MASK. These products are separated into two product types.
8. Tags is an array of commonly supported values that will evolve over time.

Tags

Tags fall into two categories: canonical and non-canonical. Besides these two categories, a tag’s value may contain units or be unitless.

Canonical

Bands

name
providerLabelId
providerLabelName
resolution
wavelengthMinimum
wavelengthMaximum

Dataset

cloudCover
creatorName
datasetSeriesName
noDataFill
platformCarrier
platformName
platformType
providerDatasetId
providerName
providerProcessingLevel
providerProductName
sensorViewAngle
solarAzimuthAngle
solarZenithAngle
version

Non-canonical

calculatedCloudCover
catalogId
countryCode
dispatchId
eopId
firstAdministrativeDivisionCode
footprintArea
internalAcquisitionEndDate
internalAcquisitionEnqueuedDate
internalAcquisitionStartDate
internalIngestionEndDate
internalIngestionStartDate
jobId
mgrsTileId
orderId
requestId
secondAdministrativeDivisionCode
uploadId

Types

measurement - consists of a quantity and unit of measure represented by the following structure.
 q - a real or integer number
 u - degree, hectare, meter or nanometer
 e.g.

{
   "q": 33.1683751057863,
   "u": "degree"
}

number - is a real or integer number
string - is a string of characters
time - is an ISO8601 formatted string of the form “YYYY-MM-DDThh:mm:ss.sssZ”

E.g. non-canonical and unitless

{
  "isCanonical": false,
  "tag": "secondAdministrativeDivisionCode",
  "tagType": "string",
  "value": "3510"
}

E.g. canonical and units

{
 "isCanonical": true,
 "tag": "solarAzimuthAngle",
 "tagType": "measurement",
 "value": {
   "q": 145.38180772158,
   "u": "degree"
 }
}

Bands

A band is defined by a key and an array of tags. The key is referenced in the products. The tags are as described above, but are generally canonical.

E.g.

{
  "key": "B1",
  "tags": [
    { 
      "isCanonical": true,
      "tag": "providerLabelId",
      "tagType": "string",
      "value": "0"
    }, 
    {
      "isCanonical": true,
      "tag": "providerLabelName", 
      "tagType": "string",
      "value": "B1"
    },
    {
      "isCanonical": true,
      "tag": "resolution",
      "tagType": "measurement",
      "value": {
        "q": 60, 
        "u": "meter"
      }
    },
    {
      "isCanonical": true,
      "tag": "wavelengthMaximum",
      "tagType": "measurement",
      "value": {
        "q": 456,
        "u": "nanometer"
      }
    },
    {
      "isCanonical": true,
      "tag": "wavelengthMinimum",
      "tagType": "measurement",
      "value": {
        "q": 411,
        "u": "nanometer"
      }
    }
  ]
}

Products

{
  "crs": "EPSG:32618",
  "datasetId": "3412b3e6-092f-4793-9c52-012dad48507e",	*1
  "format": "",
  "id": "9f583554-acb0-4784-8a69-651f92f89fc1",		*2
  "ingestDatetime": "2018-06-29T13:53:09.872Z",		*3
  "name": "",
  "previousVersion": null,
  "productType": "",
  "tags": [],						*4
  "updateDatetime": "2018-06-29T13:53:09.872Z",		*5
  "uri": "",
  "productBands": [					*6
    {
      "key": "B2",
      "offset": 2
    }, {
      "key": "B3",
      "offset": 1
    }, {
      "key": "B4",
      "offset": 0
    }, {
      "key": "B8",
      "offset": 3
    }
  ]
}

1. UUID of the containing dataset
2. UUID product identifier
3. The date time the product was ingested as an ISO8601 formatted string of the form “YYYY-MM-DDThh:mm:ss.sssZ”
4. On products, the tags array is generally empty.
5. Update datetime is the last time the product was updated as an ISO8601 formatted string of the form “YYYY-MM-DDThh:mm:ss.sssZ”
6. Product bands is an array of one or more bands that make up the product. The key maps back to the key of an element in the previously described bands array. The other information is offset, which is the numeric offset of the layer within the data.