{"_id":"573cc4241000320e009182bc","category":{"_id":"56ddf6df8a5ae10e008e3926","project":"55faeacad0e22017005b8265","pages":["56ddf8a4a6eb5c170042d72f"],"__v":1,"version":"55faeacad0e22017005b8268","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-07T21:47:11.224Z","from_sync":false,"order":18,"slug":"imagery","title":"IDAHO Guide"},"user":"55fae9d4825d5f19001fa379","parentDoc":null,"project":"55faeacad0e22017005b8265","__v":18,"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":33,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-18T19:36:04.130Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"identifier\": \"61119e3e-af0e-4230-8c24-c232203dfcbf\",\n  \"owner\": \"7b216bd9-6523-4ca9-aa3b-1d8a5994f054\",\n  \"type\": \"IDAHOImage\",\n  \"properties\": {\n    \"numXTiles\": \"35\",\n    \"tilePartition\": \"0000\",\n    \"profileName\": \"dg_1b\",\n    \"acquisitionDate\": \"2013-07-18T18:28:28.810Z\",\n    \"pniirs\": \"2.9\",\n    \"tileYOffset\": \"0\",\n    \"nativeTileFileFormat\": \"TIF\",\n    \"imageBoundsWGS84\": \"POLYGON ((-104.7916188 39.89741571, -104.57319264 39.90284448, -104.57510556 39.76884976, -104.79191682 39.76528668, -104.7916188 39.89741571))\",\n    \"colorInterpretation\": \"WORLDVIEW_8_BAND\",\n    \"vendorDatasetIdentifier1\": \"LV1B\",\n    \"epsgCode\": \"4326\",\n    \"vendorDatasetIdentifier2\": \"055228997010_01_P001\",\n    \"vendorDatasetIdentifier3\": \"10300100238AF400\",\n    \"vendorDatasetIdentifier4\": \"A0100101D0848600\",\n    \"tileXSize\": \"256\",\n    \"timestamp\": \"2013-07-18T00:00:00.000Z\",\n    \"imageWidth\": \"8714\",\n    \"sunElevation\": \"69.7\",\n    \"imageId\": \"61119e3e-af0e-4230-8c24-c232203dfcbf\",\n    \"sensorPlatformName\": \"WV02\",\n    \"sensorName\": \"8-band (Coastal, Blue, Green, Yellow, Red, Red-edge, NIR1, NIR2) Multispectral\",\n    \"sunAzimuth\": \"154.7\",\n    \"groundSampleDistanceMeters\": \"2.079\",\n    \"dataType\": \"UNSIGNED_SHORT\",\n    \"footprintWkt\": \"POLYGON ((-104.7916188 39.89741571, -104.57319264 39.90284448, -104.57510556 39.76884976, -104.79191682 39.76528668, -104.7916188 39.89741571))\",\n    \"cloudCover\": \"0.0\",\n    \"tileYSize\": \"256\",\n    \"tileXOffset\": \"0\",\n    \"tileBucketName\": \"idaho-images\",\n    \"vendorName\": \"DigitalGlobe, Inc.\",\n    \"version\": \"1.0\",\n    \"imageHeight\": \"7398\",\n    \"offNadirAngle\": \"18.8\",\n    \"numBands\": \"8\",\n    \"satAzimuth\": \"256.8\",\n    \"vendorDatasetIdentifier\": \"LV1B:055228997010_01_P001:10300100238AF400:A0100101D0848600\",\n    \"numYTiles\": \"29\",\n    \"satElevation\": \"68.8\",\n    \"imageBucketName\": \"idaho-images\"\n  }\n}"}]},"settings":"5601fdaa1ba3720d00a6b981","examples":{"codes":[{"code":"https://geobigdata.io/catalog/v1/record/61119e3e-af0e-4230-8c24-c232203dfcbf?includeRelationships=false","language":"text"}]},"method":"get","auth":"required","params":[],"url":"https://geobigdata.io/catalog/v1/record/myRecord?includeRelationships=false"},"isReference":false,"order":10,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is a search using the GBDX catalog API.\",\n  \"body\": \"For catalog searches, the root url is https://geobigdata.io.\"\n}\n[/block]\n\n\n\nIDAHO images in the GBDX catalog are stored with the \"type\"IDAHOImage.\" That means IDAHO image records in the catalog inherit the properties of that type. \n[GET Type IDAHOImage](doc:get-type-idahoimage) \n\n## Properties of an IDAHO Image in the GBDX Catalog\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"0-0\": \"identifier\",\n    \"0-1\": \"Catalog ID of a record. This is also the image ID or the IDAHO ID.\",\n    \"1-0\": \"owner\",\n    \"2-0\": \"type\",\n    \"2-1\": \"IDAHOImage\",\n    \"3-0\": \"numXTiles\",\n    \"4-0\": \"tilePartition\",\n    \"5-0\": \"profileName\",\n    \"5-1\": \"See profiles description below.\",\n    \"6-0\": \"acquisitionDate\",\n    \"6-1\": \"The date the acquisition was acquired from the satellite\",\n    \"7-0\": \"pniirs\",\n    \"8-0\": \"tileYOffset\",\n    \"9-0\": \"nativeTileFileFormat\",\n    \"10-0\": \"imageBoundsWGS84\",\n    \"10-1\": \"The footprint for the IDAHO Image\",\n    \"11-0\": \"colorInterpretation\",\n    \"11-1\": \"sensor platform + bands, for example: WORLDVIEW_8_BAND\",\n    \"12-0\": \"vendorDatasetIdentifier1\",\n    \"12-1\": \"product level. See detailed description below\",\n    \"13-0\": \"epsgCode\",\n    \"14-0\": \"vendorDatasetIdentifier2\",\n    \"14-1\": \"Product Order ID (aka SOLI) see detailed description below\",\n    \"15-0\": \"vendorDatasetIdentifier3\",\n    \"15-1\": \"catalog ID. See detailed description below\",\n    \"16-0\": \"vendorDatasetIdentifier4\",\n    \"16-1\": \"product catalog ID. See detailed description below\",\n    \"17-0\": \"tileXSize\",\n    \"18-0\": \"timestamp\",\n    \"19-0\": \"imageWidth\",\n    \"20-0\": \"sunElevation\",\n    \"21-0\": \"imageId\",\n    \"21-1\": \"The image ID for the IDAHO Image. Also the catalog ID and IDAHO ID.\",\n    \"22-0\": \"sensorPlatformName\",\n    \"22-1\": \"The satellite or sensor platform that acquired the image.\",\n    \"23-0\": \"sensorName\",\n    \"23-1\": \"bands available from the sensor\",\n    \"24-0\": \"sunAzimuth\",\n    \"25-0\": \"groundSampleDistanceMeters\",\n    \"26-0\": \"dataType\",\n    \"27-0\": \"footprintWkt\",\n    \"27-1\": \"the footprint wkt for the image\",\n    \"28-0\": \"cloudCover\",\n    \"29-0\": \"tileYSize\",\n    \"30-0\": \"tileXOffset\",\n    \"31-0\": \"tileBucketName\",\n    \"31-1\": \"The bucket location for the IDAHO tiles for the IDAHO image. To retrieve IDAHO images using the TMS service, the bucket name and IDAHO ID are required.\",\n    \"32-0\": \"vendorName\",\n    \"32-1\": \"The vendor the image came from. Most commonly \\\"DigitalGlobe, Inc.\\\"\",\n    \"33-0\": \"version\",\n    \"34-0\": \"imageHeight\",\n    \"35-0\": \"offNadirAngle\",\n    \"36-0\": \"numBands\",\n    \"37-0\": \"satAzimuth\",\n    \"38-0\": \"vendorDatasetIdentifier\",\n    \"38-1\": \"The combined values of vendorDatasetIdentifier 1-4. See detailed description below.\",\n    \"39-0\": \"numYTiles\",\n    \"40-0\": \"satElevation\",\n    \"41-0\": \"imageBucketName\"\n  },\n  \"cols\": 2,\n  \"rows\": 42\n}\n[/block]\n## Profiles\nIDAHO images fit into one of the  profiles listed here. The profile indicates which types of metadata are available for that image. \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Profile Name (profileName)\",\n    \"h-1\": \"Source Image\",\n    \"0-0\": \"dg_1b\",\n    \"0-1\": \"DigitalGlobe level 1B image.\",\n    \"h-2\": \"Metadata types\",\n    \"0-2\": \"image.json\\nrpcs.json file\\nnative_warp_spec.json file\\n histogram.json file\\n 5 rrd levels\\nDG product metadata (.IMD, .XML, etc)\",\n    \"1-0\": \"georectified_image\",\n    \"1-1\": \"geoferenced image (as opposed to a raw or otherwise unrectified image)\",\n    \"1-2\": \"image.json\\ngeoreferencing.json\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n## vendor Dataset Identifier\nFor DigitalGlobe images the vendorDatasetIdentifier is formatted; \"{PRODUCT_LEVEL}:{PRODUCT_ORDER_ID}:{CAT_ID}:{PRODUCT_CAT_ID}\". This identifier is useful as a means to reference back to other vendor-supplied catalogs.\n\nExample vendorDatasetIdentifier: \"LV1B:053864309030_01_P001:1030010037A14B00:2020010129405000\"\n\nOn a GBDX IDAHO Image record response from the catalog, it looks like this:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" \\\"vendorDatasetIdentifier1\\\": \\\"LV1B\\\",\\n    \\\"epsgCode\\\": \\\"4326\\\",\\n    \\\"vendorDatasetIdentifier2\\\": \\\"055228997010_01_P001\\\",\\n    \\\"vendorDatasetIdentifier3\\\": \\\"10300100238AF400\\\",\\n    \\\"vendorDatasetIdentifier4\\\": \\\"A0100101D0848600\\\",\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"property name\",\n    \"h-1\": \"Example value\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"vendorDatasetIdentifier1\",\n    \"0-1\": \"LV1B\",\n    \"0-2\": \"PRODUCT_LEVEL\",\n    \"1-0\": \"vendorDatasetIdentifier2\",\n    \"1-1\": \"053864309030_01_P001\",\n    \"1-2\": \"PRODUCT_ORDER_ID (also known as \\\"SOLI\\\" for \\\"sales_order_line_item\\\")\",\n    \"2-0\": \"vendorDatasetIdentifier3\",\n    \"2-1\": \"1030010037A14B00\",\n    \"2-2\": \"CAT_ID\",\n    \"3-2\": \"PRODUCT_CAT_ID\",\n    \"3-1\": \"2020010129405000\",\n    \"3-0\": \"vendorDatasetIdentifier4\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"If you know the catalog ID for an IDAHO image, you can get the record's data from the GBDX catalog. Use this API request to get the bucket location for an IDAHO image.","slug":"get-record-idaho-image","type":"endpoint","title":"GET Record IDAHO Image"}

getGET Record IDAHO Image

If you know the catalog ID for an IDAHO image, you can get the record's data from the GBDX catalog. Use this API request to get the bucket location for an IDAHO image.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "This is a search using the GBDX catalog API.", "body": "For catalog searches, the root url is https://geobigdata.io." } [/block] IDAHO images in the GBDX catalog are stored with the "type"IDAHOImage." That means IDAHO image records in the catalog inherit the properties of that type. [GET Type IDAHOImage](doc:get-type-idahoimage) ## Properties of an IDAHO Image in the GBDX Catalog [block:parameters] { "data": { "h-0": "Property", "0-0": "identifier", "0-1": "Catalog ID of a record. This is also the image ID or the IDAHO ID.", "1-0": "owner", "2-0": "type", "2-1": "IDAHOImage", "3-0": "numXTiles", "4-0": "tilePartition", "5-0": "profileName", "5-1": "See profiles description below.", "6-0": "acquisitionDate", "6-1": "The date the acquisition was acquired from the satellite", "7-0": "pniirs", "8-0": "tileYOffset", "9-0": "nativeTileFileFormat", "10-0": "imageBoundsWGS84", "10-1": "The footprint for the IDAHO Image", "11-0": "colorInterpretation", "11-1": "sensor platform + bands, for example: WORLDVIEW_8_BAND", "12-0": "vendorDatasetIdentifier1", "12-1": "product level. See detailed description below", "13-0": "epsgCode", "14-0": "vendorDatasetIdentifier2", "14-1": "Product Order ID (aka SOLI) see detailed description below", "15-0": "vendorDatasetIdentifier3", "15-1": "catalog ID. See detailed description below", "16-0": "vendorDatasetIdentifier4", "16-1": "product catalog ID. See detailed description below", "17-0": "tileXSize", "18-0": "timestamp", "19-0": "imageWidth", "20-0": "sunElevation", "21-0": "imageId", "21-1": "The image ID for the IDAHO Image. Also the catalog ID and IDAHO ID.", "22-0": "sensorPlatformName", "22-1": "The satellite or sensor platform that acquired the image.", "23-0": "sensorName", "23-1": "bands available from the sensor", "24-0": "sunAzimuth", "25-0": "groundSampleDistanceMeters", "26-0": "dataType", "27-0": "footprintWkt", "27-1": "the footprint wkt for the image", "28-0": "cloudCover", "29-0": "tileYSize", "30-0": "tileXOffset", "31-0": "tileBucketName", "31-1": "The bucket location for the IDAHO tiles for the IDAHO image. To retrieve IDAHO images using the TMS service, the bucket name and IDAHO ID are required.", "32-0": "vendorName", "32-1": "The vendor the image came from. Most commonly \"DigitalGlobe, Inc.\"", "33-0": "version", "34-0": "imageHeight", "35-0": "offNadirAngle", "36-0": "numBands", "37-0": "satAzimuth", "38-0": "vendorDatasetIdentifier", "38-1": "The combined values of vendorDatasetIdentifier 1-4. See detailed description below.", "39-0": "numYTiles", "40-0": "satElevation", "41-0": "imageBucketName" }, "cols": 2, "rows": 42 } [/block] ## Profiles IDAHO images fit into one of the profiles listed here. The profile indicates which types of metadata are available for that image. [block:parameters] { "data": { "h-0": "Profile Name (profileName)", "h-1": "Source Image", "0-0": "dg_1b", "0-1": "DigitalGlobe level 1B image.", "h-2": "Metadata types", "0-2": "image.json\nrpcs.json file\nnative_warp_spec.json file\n histogram.json file\n 5 rrd levels\nDG product metadata (.IMD, .XML, etc)", "1-0": "georectified_image", "1-1": "geoferenced image (as opposed to a raw or otherwise unrectified image)", "1-2": "image.json\ngeoreferencing.json" }, "cols": 3, "rows": 2 } [/block] ## vendor Dataset Identifier For DigitalGlobe images the vendorDatasetIdentifier is formatted; "{PRODUCT_LEVEL}:{PRODUCT_ORDER_ID}:{CAT_ID}:{PRODUCT_CAT_ID}". This identifier is useful as a means to reference back to other vendor-supplied catalogs. Example vendorDatasetIdentifier: "LV1B:053864309030_01_P001:1030010037A14B00:2020010129405000" On a GBDX IDAHO Image record response from the catalog, it looks like this: [block:code] { "codes": [ { "code": " \"vendorDatasetIdentifier1\": \"LV1B\",\n \"epsgCode\": \"4326\",\n \"vendorDatasetIdentifier2\": \"055228997010_01_P001\",\n \"vendorDatasetIdentifier3\": \"10300100238AF400\",\n \"vendorDatasetIdentifier4\": \"A0100101D0848600\",", "language": "json" } ] } [/block] [block:parameters] { "data": { "h-0": "property name", "h-1": "Example value", "h-2": "Description", "0-0": "vendorDatasetIdentifier1", "0-1": "LV1B", "0-2": "PRODUCT_LEVEL", "1-0": "vendorDatasetIdentifier2", "1-1": "053864309030_01_P001", "1-2": "PRODUCT_ORDER_ID (also known as \"SOLI\" for \"sales_order_line_item\")", "2-0": "vendorDatasetIdentifier3", "2-1": "1030010037A14B00", "2-2": "CAT_ID", "3-2": "PRODUCT_CAT_ID", "3-1": "2020010129405000", "3-0": "vendorDatasetIdentifier4" }, "cols": 3, "rows": 4 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}