Create Route Layers

The Create Route Layers task creates route layer items on the portal from the input route data.

A route layer includes all the information for a particular route such as the stops assigned to the route as well as the travel directions. Creating route layers is useful if you want to share individual routes with other members in your organization.

Route data is a storage format used to describe the results of a network analysis and can be created in ArcGIS Desktop applications such as ArcMap and ArcGIS Pro.

Limits

The maximum number of route layers that can be created is 1,000. If the input route data contains more than 1,000 routes, the task will fail with an error message.

Request URL

http://<analysis url>/CreateRouteLayers/submitJob

Request Parameters

ParameterDetails

routeData

(Required)

The item id for the route data item that is used to create route layer items. Before running this task, the route data must be added to your portal as an item.

Syntax:
{
    "itemId" : {item id of the route data item}
}

deleteRouteData

(Required)

Indicates if the input route data item should be deleted. You may want to delete the route data in case it is no longer required after the route layers have been created from it.

When deleteRouteData is set to true and the task fails to delete the route data item, it will return a warning message but still continue execution.

The default value is false.

Example: "deleteRouteData": "true"

outputName

(Required)

Specify properties such as the title, tags, snippet, and the portal folder for the output route layer items.

  • tags: Specify tags used to describe and identify the route layer items. Individual tags are separated using a comma. The route name is always added as a tag even when a value for this property is not specified.
  • snippet: Specify the summary displayed as part of the item information for the route layer item. If a value for this property is not specified, a default summary text "Route and directions for <Route Name>" is used.
  • title: A qualifier added to the title of every route layer item. This can be used to designate all routes for a specific purpose to have the same prefix in the title. The name of the route is always appended after this qualifier. If a value for this property is not specified, the title for the route layer item is created only using the route name.
  • folderId: Specify the id of an existing folder within your personal online workspace where the route layer items will be created. If a value for this property is not specified, the route layer items are created in the root folder of your online workspace.
Syntax:
{
    "itemProperties": {
        "title": "<Prefix>",
        "tags": "<tag1>, <tag2>",
        "snippet": "<A short summary common to every route item.>",
        "folderId": "<folder id>"
    }
}
Example
{
    "itemProperties": {
        "title": "Monday Routes",
        "tags": "Delivery, Priority2",
        "snippet": "Deliveries that must be performed on Monday.",
        "folderId": "edffe6469763487cb7749c10a1c39f7d"
    }
}

context

Context contains additional settings that affect task execution. Currently, Create Route Layers does not honor any settings passed as part of context.

f

The response format. The default response format is html.

Values: html | json

Response

When you submit a request, the service 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, you use the jobId to retrieve the results. To track the status, you can make a request of the following form:

http://<analysis url>/CreateRouteLayers/jobs/<jobId>

Accessing results

When the status of the job request is esriJobSucceded, you can access the results of the analysis by making a request of the following form.

http://<analysis url>/CreateRouteLayers/jobs/<jobId>/results/<output parameter name>?token=<your token>&f=json

ParameterDescription

routeLayers

The output route layer items.

Example:
{"url": 
"http://<analysis url>/CreateRouteLayers/jobs/<jobId>/results/routeLayers"}

The result has properties for parameter name, data type, and value. The contents of value include the item ids of the output route layers as well as some additional properties such as the URL for the route layer items.

Syntax:
{
  "paramName" : "routeLayers",
  "dataType" : "GPString",
  "value" : {
    "items" : {
      "<route layer 1 item id>" : {
        "url" : "<route layer 1 item URL",
        "routeName" : "<route name>",
        "title" : "<Route name prefix>:  <route name>"
      },
       "<route layer 2 item id>" : {
        "url" : "<route layer 1 item URL",
        "routeName" : "<route name>",
        "title" : "<Route name prefix>:  <route name>"
      }
    },
    "folderId" : "<folder id>",
    "portalUrl" : "<portal url>"
  }
}