Raster Key Properties—REST APIs | Documentation for ArcGIS Enterprise

URL:https://<rastercatalogitem-url>/info/keyProperties
Required Capability:Image, Catalog
Version Introduced:10.1

Description

License:

As of 10.5, you must license your ArcGIS Server as an ArcGIS Image Server in order to use this resource.

The raster keyProperties resource returns key properties of the associated raster in an image service. The output format is always JSON.

At 10.3 and later, this resource also takes an optional renderingRule parameter. You can get updated key properties if the source raster goes through a custom processing as defined by renderingRule.

Request parameters


Parameter	Details
f	The response format. The default response format is html. Values: html \| json
renderingRule	This parameter was added at 10.3 Description: Specifies the rendering rule for how the requested image should be processed. The response contains updated service information that reflects custom processing as defined by the rendering rule. For example, if renderingRule contains an attributeTable function, the response will indicate "hasRasterAttributeTable": true; if the renderingRule contains functions that alter the number of bands, the response will indicate the correct bandCount value. See the raster function JSON objects for the syntax and examples.

Example usage

Example: Return key properties of a multispectral raster in a Landsat image service:

https://sampleserver6.arcgisonline.com/arcgis/rest/services/Toronto/ImageServer/1/info/keyProperties

JSON Response syntax

            
            {
  "keyproperty1Name":"value1",
  "keyproperty2Name":value2
}

JSON Response example

            
          

 {
    "Component_ID": "0000000",
    "Product_Image_ID": "000",
    "Component_File_Name": "po_578117_pan_0000000.tif",
    "Thumbnail_File_Name": "po_578117_rgb_0000000_ovr.jpg",
    "Country_Code": "CA",
    "Component_Geographic_Corner_Coordinates": "",
    "Number_of_Coordinates": "4",
    "Coordinate": "4",
    "Latitude": "43.5824895707",
    "Longitude": "-79.3122654652",
    "Component_Map_Coordinates_(in_Map_Units)": "",
    "UL_Map_X_(Easting)": "624463.8743276052",
    "UL_Map_Y_(Northing)": "4841021.3073072685",
    "Pixel_Size_X": "1.0000000000",
    "Pixel_Size_Y": "1.0000000000",
    "Product_Order_Map_Units": "meters",
    "Columns": "11796",
    "Rows": "14136",
    "Percent_Component_Cloud_Cover": "0",
    "SrcImgID": "2007070316182540000011619942",
    "SensorName": "IKONOS-2",
    "Acquired_Nominal_GSD": "",
    "Pan_Cross_Scan": "0.8387558460",
    "Pan_Along_Scan": "0.8435839415",
    "MS_Cross_Scan": "3.3550233841",
    "MS_Along_Scan": "3.3743357658",
    "Scan_Azimuth": "180.0478336360",
    "Scan_Direction": "Reverse",
    "Panchromatic_TDI_Mode": "13",
    "SensorAzimuth": 144.9171,
    "SatAzimuth": 144.9171,
    "OffNadir": 10.533550000000005,
    "SensorElevation": 79.46645,
    "SatElevation": 79.46645,
    "SunAzimuth": 142.0678,
    "SunElevation": 65.59146,
    "AcquisitionDate": 39266.67916666667,
    "CloudCover": 0,
    "Product_Space_Metadata": "",
    "Number_of_Image_Components": "1",
    "X_Components": "1",
    "Y_Components": "1",
    "Product_MBR_Geographic_Coordinates": "",
    "Product_Map_Coordinates_(in_Map_Units)": "",
    "Reference_Height": "56.2787551880",
    "Product_Component_Metadata": "",
    "Number_of_Components": "1",
    "DataType": "Generic",
    "BlockName": "578117",
    "BandProperties": [
        {
            "BandName": "Blue",
            "WavelengthMin": 445,
            "WavelengthMax": 516,
            "DatasetTag": "MS",
            "KIND": "BAND",
            "HAS_TABLE": 0,
            "STATISTICS_MINIMUM": "0",
            "STATISTICS_MAXIMUM": "1314",
            "STATISTICS_MEAN": "396.56108374384",
            "STATISTICS_STDDEV": "119.03050703138",
            "STATISTICS_SKIPFACTORX": "50",
            "STATISTICS_SKIPFACTORY": "50"
        },
        {
            "BandName": "Green",
            "WavelengthMin": 506,
            "WavelengthMax": 595,
            "DatasetTag": "MS",
            "KIND": "BAND",
            "HAS_TABLE": 0,
            "STATISTICS_MINIMUM": "0",
            "STATISTICS_MAXIMUM": "1647",
            "STATISTICS_MEAN": "413.39630541872",
            "STATISTICS_STDDEV": "171.28394707587",
            "STATISTICS_SKIPFACTORX": "50",
            "STATISTICS_SKIPFACTORY": "50"
        },
        {
            "BandName": "Red",
            "WavelengthMin": 632,
            "WavelengthMax": 698,
            "DatasetTag": "MS",
            "KIND": "BAND",
            "HAS_TABLE": 0,
            "STATISTICS_MINIMUM": "0",
            "STATISTICS_MAXIMUM": "1508",
            "STATISTICS_MEAN": "298.989408867",
            "STATISTICS_STDDEV": "180.57524253739",
            "STATISTICS_SKIPFACTORX": "50",
            "STATISTICS_SKIPFACTORY": "50"
        },
        {
            "BandName": "NearInfrared",
            "WavelengthMin": 757,
            "WavelengthMax": 863,
            "DatasetTag": "MS",
            "KIND": "BAND",
            "HAS_TABLE": 0,
            "STATISTICS_MINIMUM": "0",
            "STATISTICS_MAXIMUM": "1364",
            "STATISTICS_MEAN": "443.55443349754",
            "STATISTICS_STDDEV": "336.23514124344",
            "STATISTICS_SKIPFACTORX": "50",
            "STATISTICS_SKIPFACTORY": "50"
        }
    ]
}

Feedback on this topic?