Profile job
The Profile request is used to sample elevation values along input lines. The output polyline feature can be used to create a profile graph.
The maximum number of input line features that can be accepted by each job request is 1,000.
Request URL
https://elevation.arcgis.com/arcgis/rest/services/Tools/Elevation/GPServer/Profile/submitJobDescription
The output from this request are polyline features with elevation values extracted along the input line features for each vertex. The elevation values are stored as z-values in the shape geometry. The distance values are stored as m-values in the shape geometry. The input polyline vertices are densified using the input maximum sample distance.
Depending on the DEM resolution selected, different data sources will be used by the request.
- By default, this request currently works worldwide between 60 degrees north and 56 degrees south based on the 3 arc-second (approximately 90-meter) resolution SRTM dataset.
- For 30m, the request will use 1 arc-second resolution data in North America (Canada, United States, and Mexico) from the USGS National Elevation Dataset (NED), SRTM DEM-S dataset from Geoscience Australia in Australia and SRTM data between 60 degrees north and 56 degrees south in the remaining parts of the world (Africa, South America, most of Europe and continental Asia, the East Indies, New Zealand, and islands of the western Pacific).
- For 24m, the request will use 0.8 arc-second (approximately 24-meter) data from the global dataset WorldDEM4Ortho from Airbus Defence and Space GmbH, excluding the countries of Azerbaijan, DR Congo, and Ukraine.
- For 10m, the request will use 1/3 arc-second resolution data in the continental United States from USGS National Elevation Dataset (NED) and approximately 10-meter data covering Norway, Finland, Denmark, Austria, Spain, Japan, Latvia, Lithuania, Slovak Republic, Italy, Switzerland, and Liechtenstein from various authoritative sources.
- For 500m, the request will use the GEBCO data covering the entire world at 15 arc-second (approximately 500-meter) resolution.
- For 1,000m, the request will use the GEBCO data covering the entire world at 30 arc-second (approximately 1,000-meter) resolution.
Refer to the locator map to see the areas covered and to learn more about the data sources currently available.
Usage
The request will return an error message if the specified resolution is not available at any of the input feature locations.
The maximum number of input lines is 1000 for each job request. If additional input lines are provided, the request will return an error and will not execute.
When the Maximum Sample Distance parameter is empty or not supplied, a default sampling distance is calculated based on how many vertices are available on the input line feature. If the input line feature contains fewer than 50 vertices, the default sampling distance is the length of the input line feature divided by 49. If the input has 50 or more, but fewer than 200 vertices, the default sampling distance is the length of the input line feature divided by 199. If the number of vertices is from 200 to the maximum of 1,024, the input line feature will not be densified if the Maximum Sample Distance parameter is empty or not specified.
The returned line features are in the same coordinate system as the input line features. The z- and m-values of the vertices are in meters.
The maximum number of elevation values returned from the request is 2,000 for each input line. The request will return an error message and will not execute if a request results in more than this maximum number of elevation values. If this occurs, you should either specify a larger sampling distance, or input a line feature with fewer vertices, or both.
The output field Length Meters holds the planimetric length of the profile line calculated as a geodesic distance and is the correct length regardless of the coordinate system of the data. This length will be different from the shape_length attribute due to the effects of map projection distortion. The output field DEMResolution records the source DEM resolution used by the request. Three additional output fields are also available that identify the DEM data source used in the calculation. Those fields are Product Name, Source, and Source URL.
When accessing the result of the Profile job request, to get the Z (elevation) and M (distance) values in the result, returnZ and returnM must be specified as true and included in the request parameters.
Request Parameters
| Parameter | Description |
|---|---|
InputLineFeatures (Required) | The line features that will be profiled over the surface.
|
ProfileIDField | A unique identifier to tie profiles to their corresponding input line features.
|
DEMResolution | The approximate spatial resolution (cell size) of the source elevation data used for the calculation. The resolution values are an approximation of the spatial resolution of the digital elevation model. While many elevation sources are distributed in units of arc seconds, the keyword is an approximation of those resolutions in meters for easier understanding.
|
MaximumSampleDistance | The maximum sampling distance along the line to sample elevation values.
|
MaximumSampleDistanceUnits | The units for the MaximumSampleDistance.
|
Response
When you submit a request, the request assigns a unique job ID for the transaction.
Syntax:
{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}After the initial request is submitted, you can use the jobId to periodically check the status of the job and messages, as described in the topic Checking job status. Once the job has successfully completed, use the jobId to retrieve the results. To track the status, you can make a request of the following form:
https://elevation.arcgis.com/arcgis/rest/services/Tools/Elevation/GPServer/Profile/jobs/<jobId>
Accessing results
When the status of the job request is esriJobSucceeded, you can access the results of the analysis by making a request of the following form:
https://elevation.arcgis.com/arcgis/rest/services/Tools/Elevation/GPServer/Profile/jobs/<jobId>/results/OutputProfile?token=<your token>&returnZ=true&returnM=true&f=jsonThe elevation values and distance values are stored as Z and M values in the result feature set. To get the Z and M values back, returnZ and returnM must be set to true and included in the request parameters.
| Parameter | Description |
|---|---|
OutputProfile (Derived) | The output profile polyline features, which is a derived output.
|