Profile—ArcGIS REST APIs

The Profile request is used to sample elevation values along input lines. The output polyline feature can be used to create a profile graph. SkipToContent ArcGISRESTAPIs HomeReady-to-useContentmanagementAllservicesEnterpriseadministration Menu OverviewElevationanalysisserviceHydrologyanalysisserviceElevationdatacoverageHydrologydatacoverageElevationrequestsProfileProfilejobSummarizeelevationViewshedHydrologyrequestsTracedownstreamWatershed BacktoTop Inthistopic RequestURLDescriptionUsageRequestParametersCompleterequestexampleResponse TheProfilerequestisusedtosampleelevationvaluesalonginputlines.Theoutputpolylinefeaturecanbeusedtocreateaprofilegraph.Themaximumnumberofinputlinefeaturesthatcanbeacceptedbyeachdirectrequestis100. RequestURLhttps://elevation.arcgis.com/arcgis/rest/services/Tools/ElevationSync/GPServer/Profile/execute DescriptionTheoutputfromthisrequestarepolylinefeatureswithelevationvaluesextractedalongtheinputlinefeaturesforeachvertex.Theelevationvaluesarestoredasz-valuesintheshapegeometry.Thedistancevaluesarestoredasm-valuesintheshapegeometry.Theinputpolylineverticesaredensifiedusingtheinputmaximumsampledistance.DependingontheDEMresolutionselected,differentdatasourceswillbeusedbytherequest.Bydefault,thisrequestcurrentlyworksworldwidebetween60degreesnorthand56degreessouthbasedonthe3arc-second(approximately90-meter)resolutionSRTMdataset.For30m,therequestwilluse1arc-secondresolutiondatainNorthAmerica(Canada,UnitedStates,andMexico)fromtheUSGSNationalElevationDataset(NED),SRTMDEM-SdatasetfromGeoscienceAustraliainAustraliaandSRTMdatabetween60degreesnorthand56degreessouthintheremainingpartsoftheworld(Africa,SouthAmerica,mostofEuropeandcontinentalAsia,theEastIndies,NewZealand,andislandsofthewesternPacific).For24m,therequestwilluse0.8arc-second(approximately24-meter)datafromtheglobaldatasetWorldDEM4OrthofromAirbusDefenceandSpaceGmbH,excludingthecountriesofAzerbaijan,DRCongo,andUkraine.For10m,therequestwilluse1/3arc-secondresolutiondatainthecontinentalUnitedStatesfromUSGSNationalElevationDataset(NED)andapproximately10-meterdatacoveringNorway,Finland,Denmark,Austria,Spain,Japan,Latvia,Lithuania,SlovakRepublic,Italy,Switzerland,andLiechtensteinfromvariousauthoritativesources.For500m,therequestwillusetheGEBCOdatacoveringtheentireworldat15arc-second(approximately500-meter)resolution.For1,000m,therequestwillusetheGEBCOdatacoveringtheentireworldat30arc-second(approximately1,000-meter)resolution.Refertothelocatormaptoseetheareascoveredandtolearnmoreaboutthedatasourcescurrentlyavailable. UsageTherequestwillreturnanerrormessageifthespecifiedresolutionisnotavailableatanyoftheinputfeaturelocations.Themaximumnumberofinputlinesis100foreachdirectrequest.Ifadditionalinputlinesareprovided,therequestwillreturnanerrorandwillnotexecute.WhentheMaximumSampleDistanceparameterisemptyornotsupplied,adefaultsamplingdistanceiscalculatedbasedonhowmanyverticesareavailableontheinputlinefeature.Iftheinputlinefeaturecontainsfewerthan50vertices,thedefaultsamplingdistanceisthelengthoftheinputlinefeaturedividedby49.Iftheinputhas50ormore,butfewerthan200vertices,thedefaultsamplingdistanceisthelengthoftheinputlinefeaturedividedby199.Ifthenumberofverticesisfrom200tothemaximumof1,024,theinputlinefeaturewillnotbedensifiediftheMaximumSampleDistanceparameterisemptyornotspecified.Thereturnedlinefeaturesareinthesamecoordinatesystemastheinputlinefeatures.Thez-andm-valuesoftheverticesareinmeters.Themaximumnumberofelevationvaluesreturnedfromtherequestis2,000foreachinputline.Therequestwillreturnanerrormessageandwillnotexecuteifarequestresultsinmorethanthismaximumnumberofelevationvalues.Ifthisoccurs,youshouldeitherspecifyalargersamplingdistance,orinputalinefeaturewithfewervertices,orboth.TheoutputfieldLengthMetersholdstheplanimetriclengthoftheprofilelinecalculatedasageodesicdistanceandisthecorrectlengthregardlessofthecoordinatesystemofthedata.Thislengthwillbedifferentfromtheshape_lengthattributeduetotheeffectsofmapprojectiondistortion.TheoutputfieldDEMResolutionrecordsthesourceDEMresolutionusedbytherequest.ThreeadditionaloutputfieldsarealsoavailablethatidentifytheDEMdatasourceusedinthecalculation.ThosefieldsareProductName,Source,andSourceURL.WhensubmittingtheexecuterequestforthesynchronousProfilerequest,returnZandreturnMmustbespecifiedastrueandincludedintherequestparametersinordertogettheZ(elevation)andM(distance)values.AnexampleofanexecutestringwiththeZandMenabledisprovidedinasubsequentsection. RequestParametersParameterDescriptionInputLineFeatures(Required)Thelinefeaturesthatwillbeprofiledoverthesurface.Type:FeatureSetSyntax: { "geometryType":"geometryType", "spatialReference":, "fields":, "features":, }ProfileIDFieldAuniqueidentifiertotieprofilestotheircorrespondinginputlinefeatures.Type:String DEMResolutionTheapproximatespatialresolution(cellsize)ofthesourceelevationdatausedforthecalculation.Theresolutionvaluesareanapproximationofthespatialresolutionofthedigitalelevationmodel.Whilemanyelevationsourcesaredistributedinunitsofarcseconds,thekeywordisanapproximationofthoseresolutionsinmetersforeasierunderstanding.Type:StringValues:FINEST|10m|24m|30m|90m|500m|1000m MaximumSampleDistanceThemaximumsamplingdistancealongthelinetosampleelevationvalues.Type:Double MaximumSampleDistanceUnitsTheunitsfortheMaximumSampleDistance.Type:StringValues:Meters|Kilometers|Feet|Yards|MilesDefault:Meters CompleterequestexampleTheprofileelevationanddistancevaluesarestoredastheZandMvaluesintheresultfeatureset.WhensubmittingtherequesttoexecutethesynchronousProfilerequest,returnZandreturnMmustbesettotrueandincludedintherequestparameters.Thefollowingisanexampleofthecompleteformofanexecuterequest:https://elevation.arcgis.com/arcgis/rest/services/Tools/ElevationSync/GPServer/Profile/execute?f=json&InputLineFeatures=&ProfileIDField=OID&DEMResolution=FINEST&MaximumSampleDistance=13&MaximumSampleDistanceUnits=Meters&returnZ=true&returnM=true ResponseIftherequestissuccessful,theresponsefromtheProfilerequestisapolylineFeatureSet.Thenumberofreturnedlinefeaturesisthesameasthenumberoflinefeaturesintheinput.ThefollowingexampleillustratesthereturnedJSONstructureforasuccessfulrequest:JSONresponsesyntaxforsuccessfulrequest { "results":[{ "paramName":"OutputProfile", "dataType":"GPFeatureRecordSetLayer", "value":{ "displayFieldName":"", "geometryType":"esriGeometryPolyline", "spatialReference":{ "wkid":, "latestWkid": }, "fields":[ { }, { }, { } ], "features":[{ "attributes":{ "OBJECTID":1, "DEMResolution":, "ProfileLength":, "Shape_Length": }, "geometry":{"paths":[[ [ x, y, z, m ], [ x, y, z, m ], [ ]], [ ]]} }], "exceededTransferLimit":false } }], "messages":[] } Inthistopic RequestURLDescriptionUsageRequestParametersCompleterequestexampleResponse