facilities

Las ubicaciones de entrada alrededor de las cuales se generan áreas de servicio.

You can specify facility geometries as well as attributes using a more comprehensive JSON structure that represents a set of features. The property is optional; however, the JSON structure must specify either the url or features property:

• url: especifique una solicitud de consulta REST para cualquier entidad, mapa o servicio de geoprocesamiento de ArcGIS Server que devuelva un conjunto de entidades JSON.

• features: especifique una matriz de entidades.

  Each feature in the features array represents a facility and contains the following properties:

  • geometry: especifique la geometría de punto de entrada que contenga las propiedades x y y junto con la propiedad spatialReference. Si la propiedad spatialReference se define para todo el JSON, no es necesario que defina esta propiedad para cada geometría. Al hacerlo, se reduce el tamaño del JSON de entrada si la entrada tiene muchas entidades y también mejora el rendimiento. Esta propiedad no es necesaria si las coordenadas están en la referencia espacial predeterminada, WGS84. Si las coordenadas están en una referencia espacial diferente, debe especificar el Id. conocido de la referencia espacial (WKID). Consulte Utilizar referencias espaciales para buscar valores de WKID.

    Sugerencia:

    Se recomienda especificar explícitamente el valor de spatialReference y especificarlo para todo el JSON en lugar de para cada geometría individual.

  • attributes: especifique cada atributo como un par de clave-valor donde la clave es el nombre de un campo dado y el valor es el valor de atributo del campo correspondiente.

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "x": <x1>,
        "y": <y1>
      },
      "attributes": {
        "<field1>": <value1_1>,
        "<field2>": <value1_2>
      }
    },
    {
      "geometry": {
        "x": <x2>,
        "y": <y2>
      },
      "attributes": {
        "<field1>": <value2_1>,
        "<field2>": <value2_2>
      }
    }
  ] 
}

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "fields": [
    {
      "name": <name1>,
      "type": <esriFieldType>,
      "alias": <alias1>,
      "length": <length>
    },
    {
      "name": <name2>,
      "type": <esriFieldType>,
      "alias": <alias2>,
      "length": <length>
    }
  ],
  "features": [
    {
      "geometry": {
        "x": <x1>,
        "y": <y1>
      },
      "attributes": {
        "<name1>": <value1_1>,
        "<name2>": <value1_2>
      }
    },
    {
      "geometry": {
        "x": <x2>,
        "y": <y2>
      },
      "attributes": {
        "<name1>": <value2_1>,
        "<name2>": <value2_2>
      }
    }
  ] 
}

{
  "url": "<url>"
}

{
  "features": [
    {
      "geometry": {
        "x": -0.1891,  
        "y": 51.5254
      },
      "attributes": {
        "Name": "Fire Station 35"                             
      }
    },
    {
      "geometry": {
        "x": -0.1744,
        "y": 51.5353
      },
      "attributes": {
        "Name": "Fire Station 29"
      }
    }
  ]
}

{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {                
        "x": 2698533.989,
        "y": 5192521.476
      },
      "attributes": {
        "Name": "123 Main Street" 
      }
    },
    {
      "geometry": {
        "x": 2697821.094, 
        "y": 5191915.261
      },
      "attributes": {
        "Name": "845 Cypress Ave"
      }
    }
  ]
}

{
  "fields": [
    {
      "name": "Name",
      "type": "esriFieldTypeString",
      "alias": "Square Footage",
      "length": 128
    },
    {
      "name": "SquareFootage",
      "type": "esriFieldTypeInteger",
      "alias": "Square Footage",
      "length": 10
    }
  ],
  "features": [
    {
      "geometry": {
        "x": -122.253,
        "y": 37.757
      },
      "attributes": {
        "Name": "SF Store",
        "SquareFootage": 1800
      }
    },
    {
      "geometry": {
        "x": -77.067,
        "y": 38.907
      },
      "attributes": {
        "Name": "DC Store",
        "SquareFootage": 1300
      }
    }
  ]
}

{
  "url": "https://machine.domain.com/webadaptor/rest/services/NetworkAnalysis/SanDiego/MapServer/21/query?where=1%3D1&outFields=Name&f=json"
}

token

Utilice este parámetro para especificar un token que proporcione la identidad de un usuario que tenga permisos para acceder al servicio. La página de seguridad y autenticación ofrece más información sobre cómo se puede obtener un token de acceso.

token=<yourToken>

f

Utilice este parámetro para especificar el formato de respuesta. El parámetro puede tener html, json o pjson como argumentos, por ejemplo, f=json. El valor pjson se utiliza para imprimir la respuesta JSON en un formato embellecido.

travel_mode

Seleccione el modo de transporte para el análisis.

Los modos de viaje se administran en ArcGIS Enterprise y el administrador de su organización puede configurarlos para reflejar mejor los flujos de trabajo de la organización.

Para obtener más información sobre los modos de viaje, consulte Configurar modos de viaje.

Debe especificar el objeto JSON que contiene la configuración de un modo de viaje compatible con su organización. Para obtener una lista de los modos de viaje admitidos, ejecute la herramienta GetTravelModes desde el servicio Utilidades.

El valor del parámetro travel_mode debe ser un objeto JSON que represente la configuración del modo de viaje. Si se utiliza la herramienta GetTravelModes del servicio Utilidades, se obtiene una cadena de caracteres que representa el JSON del modo de viaje. Debe convertir esta cadena de caracteres en un objeto JSON válido utilizando su API y, a continuación, entregar el objeto JSON como valor para el parámetro travel_mode.

Por ejemplo, se muestra a continuación una cadena de caracteres que representa el modo de viaje Tiempo a pie, tal y como lo devuelve la herramienta GetTravelModes.

"{\"attributeParameterValues\": [{\"parameterName\": \"Restriction Usage\", \"attributeName\": \"Walking\", \"value\": \"PROHIBITED\"}, {\"parameterName\": \"Restriction Usage\", \"attributeName\": \"Preferred for Pedestrians\", \"value\": \"PREFER_LOW\"}, {\"parameterName\": \"Walking Speed (km/h)\", \"attributeName\": \"WalkTime\", \"value\": 5}], \"description\": \"Follows paths and roads that allow pedestrian traffic and finds solutions that optimize travel time. The walking speed is set to 5 kilometers per hour.\", \"impedanceAttributeName\": \"WalkTime\", \"simplificationToleranceUnits\": \"esriMeters\", \"uturnAtJunctions\": \"esriNFSBAllowBacktrack\", \"restrictionAttributeNames\": [\"Preferred for Pedestrians\", \"Walking\"], \"useHierarchy\": false, \"simplificationTolerance\": 2, \"timeAttributeName\": \"WalkTime\", \"distanceAttributeName\": \"Miles\", \"type\": \"WALK\", \"id\": \"caFAgoThrvUpkFBW\", \"name\": \"Walking Time\"}"

El valor anterior se debe convertir a un objeto JSON válido y transferirse como valor para el parámetro travel_mode.

travel_mode={"attributeParameterValues":[{"parameterName":"Restriction Usage","attributeName":"Walking","value":"PROHIBITED"},{"parameterName":"Restriction Usage","attributeName":"Preferred for Pedestrians","value":"PREFER_LOW"},{"parameterName":"Walking Speed (km/h)","attributeName":"WalkTime","value":5}],"description":"Follows paths and roads that allow pedestrian traffic and finds solutions that optimize travel time. The walking speed is set to 5 kilometers per hour.","impedanceAttributeName":"WalkTime","simplificationToleranceUnits":"esriMeters","uturnAtJunctions":"esriNFSBAllowBacktrack","restrictionAttributeNames":["Preferred for Pedestrians","Walking"],"useHierarchy":false,"simplificationTolerance":2,"timeAttributeName":"WalkTime","distanceAttributeName":"Miles","type":"WALK","id":"caFAgoThrvUpkFBW","name":"Walking Time"}

El valor predeterminado, Custom, le permite configurar su propio modo de viaje. Cuando se entrega en Custom, puede definir valores para los siguientes parámetros: impedance, time_impedance, distance_impedance, uturn_at_junctions, use_hierarchy, route_line_simplification_tolerance, restrictions y attribute_parameter_values. Puede elegir Custom y establecer los parámetros de modo de viaje personalizado indicados anteriormente, por ejemplo, para modelar un peatón con una velocidad de caminata rápida o un camión con una altura y un peso determinados y con una carga de determinados materiales peligrosos. Puede probar distintas configuraciones hasta conseguir resultados de análisis deseados. Una vez que haya identificado la configuración de análisis, debe trabajar con el administrador de su organización y guardar esta configuración como parte de un modo de viaje nuevo o existente para que todos los usuarios de su organización puedan volver a ejecutar el análisis con la misma configuración.

Los valores predeterminados de los parámetros de modo de viaje personalizado se basan en viajes en coche. Si especifica el modo de viaje como Custom o no proporciona ningún valor para el parámetro travel_mode, el análisis será similar al uso del modo de viaje Driving Time predeterminado.

break_values

Use este parámetro para especificar el tamaño y el número de áreas de servicio a generar para cada instalación. Las unidades se determinan con el parámetro break_units. Si las unidades se basan en el tiempo, las áreas de servicio se generan en función del tiempo de viaje a lo largo de las calles subyacentes. Si las unidades se basan en la distancia, las áreas de servicio se generan en función de la distancia de viaje.

Se pueden especificar varios descansos de área para crear áreas de servicio concéntricas por instalación. Por ejemplo, para encontrar áreas de servicio a 2, 3 y 5 millas para cada instalación, especifique break_values=2 3 5 separando los valores con un espacio y defina break_units como Miles.

El valor predeterminado de este parámetro se muestra en el ejemplo que aparece a continuación:

break_values=5 10 15

break_units

Utilice este parámetro para especificar las unidades del parámetro break_values. El parámetro se especifica con estos valores:

• Meters
• Kilometers
• Feet
• Yards
• Miles
• NauticalMiles
• Seconds
• Minutes
• Hours
• Days

El valor predeterminado es Minutes.

analysis_region

El servicio ignora este parámetro y la especificación de un valor no tiene ningún efecto en el análisis.

travel_direction

Especifica si la dirección de recorrido que se utiliza para generar los polígonos de área de servicio se acerca a las instalaciones o se aleja de ellas.

• Facility to Incident: la dirección del viaje es desde las instalaciones hasta los incidentes.
• Incident to Facility: la dirección del viaje es desde los incidentes hasta las instalaciones.

La dirección de viaje puede cambiar la forma de los polígonos porque las impedancias en lados opuestos de las calles pueden diferir o pueden existir restricciones de un solo sentido, como calles de una sola vía. La dirección que debería elegir depende de la naturaleza de su análisis del área de servicio. El área de servicio de una tienda de entrega de pizzas, por ejemplo, se debe crear alejada de la instalación, mientras que el área de servicio de un hospital se debe crear cerca de la instalación.

El valor predeterminado de este parámetro es Incident to Facility.

time_of_day

Especifique la hora y la fecha en la que desea salir o llegar a instalaciones. Este parámetro se ignora a menos que break_units esté configurado con unidades de distancia.

Para usar el tráfico en el análisis, establezca break_units en una unidad basada en tiempo y asigne un valor a time_of_day. El valor de time_of_day representa la hora a la que comienza el viaje, o parte, de los puntos de entrada. La hora se especifica como hora UNIX (milisegundos desde medianoche, 1 de enero de 1970).

La interpretación del valor de parámetro depende de si el viaje es hacia las instalaciones o desde ellas, según se especifique en el parámetro travel_direction.

• Representa la hora de salida si travel_direction tiene el valor Away From Facility. Esta es la opción predeterminada.
• Representa la hora de llegada si travel_direction tiene el valor Towards Facility.

Si no se aprueba una hora del día, el servicio utiliza velocidades de carretera estáticas basadas en velocidades históricas promedio o límites de velocidad permitidos. Utiliza las velocidades permitidas en áreas donde la información de tráfico histórico no está disponible.

Cuando el servicio utiliza datos de ArcGIS StreetMap Premium, puede admitir dos tipos de tráfico: en directo y típico.

Si la time_Of_day especificada está a menos de 4 horas de la hora actual, se utilizará el tráfico en directo cuando esté disponible. El tráfico en directo recupera las velocidades en función de los registros desde teléfonos móviles, sensores y otras fuentes de datos y refleja las velocidades de viaje actuales y predice las velocidades del futuro cercano. Si la time_Of_day especificada es 4 horas anterior o 4 horas posterior de la hora actual o si la carretera no tiene tráfico en directo, se utilizarán velocidades de tráfico típico. Las velocidades típicas se basan en patrones de tráfico históricos. Los datos de tiempo de viaje se agregan en intervalos de 15 minutos por día de la semana basándose en datos de varios años. Por tanto, una carretera puede tener un tiempo de viaje diferente un lunes a las 8:00, un lunes a las 8:15 o un martes a las 8:00. Debido a que la varianza es solo en el día de la semana y en la hora del día, el tiempo de viaje es el mismo en una carretera para cualquier lunes a las 8:00, independientemente del mes o año.

Si su objetivo es modelar las condiciones típicas de viaje y evitar grandes varianzas a partir de la media debido al tráfico en directo, se recomienda usar una fecha del pasado para garantizar que no coincida con la ventana de 4 horas desde la hora actual. Como ejemplo extremo, incluso puede utilizar fechas de 1990.

La página Cobertura de datos muestra los países para los que Esri proporciona actualmente datos de tráfico.

"time_Of_day": 631458180000

"time_Of_day": 631731600000

"time_Of_day": 1426674000000

time_zone_for_time_of_day

Especifique la zona o zonas horarias del parámetro time_Of_day. Existen dos opciones: Geographically Local y UTC.

The default value is Geographically Local

Falso (utilizar zonas horarias geográficamente locales)

El valor timeOfDay hace referencia a las zonas horarias locales en las que se encuentran los puntos de entrada. Esta opción hace que el análisis tenga horas de inicio rotativas en las diferentes zonas horarias.

La siguiente imagen ilustra cómo establecer el valor en false (geográficamente local). Establecer timeOfDay como 9:00, 4 de enero de 1990 (631443600000 milisegundos) y timeOfDayIsUTC como false, y enviar una solicitud válida provoca que los tiempos de conducción de puntos en la zona horaria del este empiecen a las 9:00 y a las 9:00 hora central para puntos en la zona horaria central. (Las horas de inicio tienen una variación de una hora respecto a la hora real o UTC).

Verdadero (usar UTC)

El valor timeOfDay hace referencia a la hora universal coordinada (UTC). Las horas de inicio son simultáneas para todos los puntos, independientemente de las zonas horarias.

La siguiente imagen ilustra cómo establecer el valor en true (UTC). Establecer timeOfDay como 9:00, 4 de enero de 1990 (631443600000 milisegundos) y timeOfDayIsUTC como true hace que el tiempo de inicio de los puntos en la zona horaria del este sean las 4:00 hora del este y las 3:00 hora central para quienes se encuentren en la zona horaria central.

use_hierarchy

Use este parámetro para especificar si se utilizará jerarquía para generar las áreas de servicio.

• true: el servicio utilizará la jerarquía. Cuando se generan áreas de servicio jerárquicas, el servicio prefiere calles de orden superior, como autovías, frente a calles de orden inferior, como carreteras locales. Significa que si una instalación se encuentra en una carretera local (el nivel más bajo en una jerarquía), el servicio abarca las carreteras locales en esa área, pero intenta aumentar la jerarquía a vías secundarias y principales. Una vez en vías secundarias o principales, el servicio omite las carreteras locales durante el resto del área de servicio. Principalmente debido a este enfoque jerárquico, las áreas de servicio jerárquicas se generan mucho más rápido en comparación con las áreas de servicio no jerárquicas, ya que el servicio tiene que generar áreas de servicio a partir de un subconjunto de calles relativamente más pequeño. Es posible usar áreas de servicio jerárquicas para simular la preferencia del conductor de viajar por autovías en lugar de carreteras locales, aunque esto suponga un viaje más largo. Sin embargo, las áreas pueden superponerse a algunas carreteras de menor orden a las que no se puede llegar dentro de una distancia de viaje o tiempo de viaje determinados. Por consiguiente, las áreas de servicio jerárquicas pueden ser menos precisas.

• false: el servicio no utilizará la jerarquía. El resultado son áreas de servicio que se miden a lo largo de todas las calles, independientemente del nivel de jerarquía, y tienden a ser de mayor calidad en comparación con sus equivalentes jerárquicos.

El valor predeterminado es false.

Algunos parámetros de servicio no se aplican al generar áreas de servicio jerárquicas.

• El parámetro polygon_trim_distance se ignora y, si se especifica, genera un mensaje de advertencia en la respuesta del servicio.
• La generación de áreas de servicio detalladas, especificadas utilizando el valor true para el parámetro detailed_polygons, no se admite y da como resultado una solicitud fallida.

• El parámetro polygon_trim_distance se ignora y, si se especifica, genera un mensaje de advertencia en la respuesta del servicio.
• La generación de áreas de servicio detalladas, especificadas utilizando el valor true para el parámetro detailed_polygons, no se admite y da como resultado una solicitud fallida.

uturn_at_junctions

Use este parámetro para restringir o permitir que la ruta haga cambios de sentido en los cruces.

Para comprender los valores del parámetro disponibles, un cruce es un punto donde solo hay dos calles que intersecan entre sí. Si hay tres o más calles que se intersecan en un punto, se llama intersección. Un cul-de-sac es una calle sin salida. Este parámetro puede tener los siguientes valores:

Parameter Value	Description
Allowed	Los cambios de sentido están permitidos en todas partes. Permitir los cambios de sentido implica que el vehículo puede girar en un cruce y volver por la misma calle.
Allowed only at Intersections and Dead Ends	Los cambios de sentido están prohibidos en los cruces donde se cruzan dos calles.
Allowed only at Dead Ends	Los cambios de sentido están prohibidos en todos los cruces y todas las intersecciones y solo se permiten en calles sin salida.
Not Allowed	Los cambios de sentido están prohibidos en todos los cruces, todas las intersecciones y todas las calles sin salida. Aunque se elija este valor para el parámetro, una ruta puede hacer cambios de sentido en paradas. Para prohibir los cambios de sentido en una parada, puede cambiar la propiedad CurbApproach al valor adecuado (3).

El valor predeterminado de este parámetro es Allowed only at Intersections and Dead Ends.

polygons_for_multiple_facilities

Utilice este parámetro para especificar cómo generar áreas de servicio cuando existan varias instalaciones. El parámetro se puede especificar usando uno de los siguientes valores:

• Overlapping: crear áreas de servicio individuales para cada instalación. Las áreas de servicio de distintas instalaciones se pueden superponer entre sí.
• Not Overlapping: crear áreas de servicio individuales para cada instalación de modo que un área de servicio de una instalación no se pueda superponer sobre áreas de servicio de otras instalaciones. Con esta opción, el área contenida en un área de servicio determinada está más cerca de la instalación correspondiente que cualquier otra instalación.
• Merge by Break Value: unir las áreas de servicio de diferentes instalaciones que poseen los mismos valores de descanso. A diferencia de las opciones Overlapping y Not Overlapping, esta opción no resulta en áreas de servicio individuales para cada instalación.

El valor predeterminado de este parámetro es Overlapping.

polygon_overlap_type

Utilice este parámetro para especificar si se crean varias áreas de servicio alrededor de una instalación como discos o anillos. El parámetro se puede especificar usando uno de los siguientes valores:

• Rings: al crear varias áreas de servicio alrededor de una instalación, no se incluya la región cubierta por el área de servicio más pequeña en la región cubierta por el área de servicio más grande. Use esta opción si desea buscar el área desde un corte a otro. Por ejemplo, si crea áreas de servicio de 5 y 10 minutos, el área de servicio de 10 minutos excluirá el área bajo el área de servicio de 5 minutos y entonces aparecerán como anillos.
• Disks: al crear varias áreas de servicio alrededor de una instalación, se crean áreas de servicio que van desde la instalación hasta el descanso. Por ejemplo, si crea áreas de servicio de 5 y 10 minutos, el área de servicio de 10 minutos incluirá el área bajo el área de servicio de 5 minutos.

El valor predeterminado de este parámetro es Rings.

detailed_polygons

Utilice este parámetro para especificar la opción para crear áreas de servicio detalladas o generalizadas.

El valor predeterminado de este parámetro es false.

polygon_trim_distance

Use este parámetro para especificar la distancia en la que se recortarán las áreas de servicio. Resulta útil al buscar áreas de servicio en lugares que tienen redes de calles muy dispersas y no desea que el área de servicio abarque áreas grandes sin entidades de calles.

El parámetro se especifica como una estructura JSON que contiene las siguientes propiedades:

• distance: el valor de distancia de corte. Un valor de distancia de 0 (cero) especifica que no se deben recortar las áreas de servicio.
• units: las unidades del valor de distancia de corte.

El valor de la propiedad debe especificarse como uno de los siguientes valores:

• esriCentimeters
• esriDecimalDegrees
• esriDecimeters
• esriFeet
• esriInches
• esriKilometers
• esriMeters
• esriMiles
• esriMillimeters
• esriNauticalMiles
• esriPoints
• esriYards

El valor predeterminado de este parámetro es 100 metros. El valor del parámetro se ignora si el parámetro use_hierarchy tiene el valor true.

 
{
  "distance": <value>,
  "units": "<unit>"
}

 
{
  "distance": 75,
  "units": "esriMeters"
}

polygon_simplification_tolerance

Utilice este parámetro para especificar en qué medida desea simplificar la geometría de las áreas de servicio devueltas por el servicio.

La simplificación mantiene los puntos críticos de un área para definir su forma esencial y quita el resto de los puntos. La distancia de simplificación que especifique será el desplazamiento máximo permisible que puede apartarse el área simplificada del área original. Simplificar un área reduce el número de puntos que se utilizan para construir el área y tiende a reducir los tiempos de dibujo.

El parámetro se especifica como una estructura JSON que contiene las siguientes propiedades:

• distance: el valor de distancia de simplificación.
• units: las unidades del valor de distancia de simplificación.

  El valor de la propiedad debe especificarse como uno de los siguientes valores:

  • esriCentimeters
  • esriDecimalDegrees
  • esriDecimeters
  • esriFeet
  • esriInches
  • esriKilometers
  • esriMeters
  • esriMiles
  • esriMillimeters
  • esriNauticalMiles
  • esriPoints
  • esriYards

El valor predeterminado de este parámetro es de 10 metros.

 
{
  "distance": <value>,
  "units": "<unit>"
}

 
{
  "distance": 10,
  "units": "esriMeters"
}

point_barriers

Utilice este parámetro para especificar uno o varios puntos que actuarán como restricciones temporales o representen el tiempo o la distancia adicionales que puede que se necesiten para viajar en las calles subyacentes. Por ejemplo, una barrera de punto se puede usar para representar un árbol caído en una calle o el retraso acumulado en un cruce de ferrocarril.

You can specify barrier geometries as well as attributes using a more comprehensive JSON structure that references a set of features. The property is optional; however, the JSON structure must specify either the url or features property:

• url: especifique una solicitud de consulta REST para cualquier entidad, mapa o servicio de geoprocesamiento de ArcGIS Server que devuelva un conjunto de entidades JSON.

• features: especifique una matriz de entidades.

  Cada entidad de la matriz representa una barrera de punto y contiene los siguientes campos:

  • geometry: especifique la geometría de punto de entrada que contenga las propiedades x y y junto con la propiedad spatialReference. Si la propiedad spatialReference se define para todo el JSON, no es necesario que defina esta propiedad para cada geometría. Al hacerlo, se reduce el tamaño del JSON de entrada si la entrada tiene muchas entidades y también mejora el rendimiento. Esta propiedad no es necesaria si las coordenadas están en la referencia espacial predeterminada, WGS84. Si las coordenadas están en una referencia espacial diferente, debe especificar el Id. conocido de la referencia espacial (WKID). Consulte Utilizar referencias espaciales para buscar valores de WKID.

    Sugerencia:

    Se recomienda especificar explícitamente el valor de spatialReference y especificarlo para todo el JSON en lugar de para cada geometría individual.

  • attributes: especifique cada atributo como un par de clave-valor donde la clave es el nombre de un campo dado y el valor es el valor de atributo del campo correspondiente.

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "x": <x1>,
        "y": <y1>
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "x": <x2>,
        "y": <y2>
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ] 
}

{
  "url": "<url>"
}

{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "x": 37.541479,
        "y": -122.053461
      },
      "attributes": {
        "Name": "Haley St railroad crossing",
        "BarrierType": 2,
        "Additional_Time": 5
      }
    }
  ]
}

{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {
        "y": -13635398.9398,
        "x": 4544699.034400001
      },
      "attributes": {
        "Name": "Fallen tree at 123 Main St", 
        "BarrierType": 0
      }
    }
  ]
}

{
  "url": "https://machine.domain.com/webadaptor/rest/services/NetworkAnalysis/SanDiego/MapServer/21/query?where=1%3D1&outFields=Name&f=json"
}

line_barriers

Utilice este parámetro para especificar una o varias líneas que prohíban viajar a cualquier ubicación en la que las líneas se intersequen con las calles. Por ejemplo, un desfile o una protesta que bloquee el tráfico por varios segmentos de calle se puede modelar con una barrera de línea. Una barrera de línea también puede cercar rápidamente varios caminos para que no se puedan atravesar, alejando así las posibles rutas de las partes no deseadas de la red de calles.

You can specify polyline barrier geometries as well as attributes using a JSON structure that references a set of features. The property is optional; however, the JSON structure must specify either the url or features property:

• url: especifique una solicitud de consulta REST para cualquier entidad, mapa o servicio de geoprocesamiento de ArcGIS Server que devuelva un conjunto de entidades JSON.

• features: especifique una matriz de entidades.

  Cada entidad de la matriz representa una barrera de polilínea y contiene los siguientes campos:

  • geometry: especifique la geometría de punto de entrada que contenga las propiedades x y y junto con la propiedad spatialReference. Si la propiedad spatialReference se define para todo el JSON, no es necesario que defina esta propiedad para cada geometría. Al hacerlo, se reduce el tamaño del JSON de entrada si la entrada tiene muchas entidades y también mejora el rendimiento. Esta propiedad no es necesaria si las coordenadas están en la referencia espacial predeterminada, WGS84. Si las coordenadas están en una referencia espacial diferente, debe especificar el Id. conocido de la referencia espacial (WKID). Consulte Utilizar referencias espaciales para buscar valores de WKID.

    Sugerencia:

    Se recomienda especificar explícitamente el valor de spatialReference y especificarlo para todo el JSON en lugar de para cada geometría individual.

  • attributes: especifique cada atributo como un par de clave-valor donde la clave es el nombre de un campo dado y el valor es el valor de atributo del campo correspondiente.

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>, 
  },
  "features": [
    {
      "geometry": {
        "paths": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>]
          ]
        ]
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
		  {
      "geometry": {
        "paths": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>]
        ]
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ] 
}

{
  "url": "<url>"
}

{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {
        "paths": [
          [
            [-10804823.397,3873688.372],
            [-10804811.152,3873025.945]
          ]
        ]
      },
      "attributes": {
        "Name": "Barrier 1"
      }
    },
    {
      "geometry": {
        "paths": [
          [
            [-10804823.397,3873688.372],
            [-10804807.813 3873290.911],
            [-10804811.152,3873025.945]
          ],
          [
            [-10805032.678,3863358.76],
            [-10805001.508,3862829.281]
          ]
        ]
      },
      "attributes": {
        "Name": "Barrier 2"
      }
    }
  ]
}

{
  "url": "https://machine.domain.com/webadaptor/rest/services/Network/USA/MapServer/6/query?where=1%3D1&returnGeometry=true&f=json"
}

polygon_barriers

Utilice este parámetro para especificar polígonos que restrinjan completamente el viaje o ajusten de una forma proporcional el tiempo o la distancia que se requieren para viajar por las calles que se intersecan con los polígonos.

You can specify polygon barrier geometries as well as attributes using a JSON structure that references a set of features. The JSON structure can be specified using the url or features property:

• url: especifique una solicitud de consulta REST para cualquier entidad, mapa o servicio de geoprocesamiento de ArcGIS Server que devuelva un conjunto de entidades JSON.

• features: especifique una matriz de entidades.

  Cada entidad de la matriz representa una barrera de polígono y contiene los siguientes campos:

  • geometry: especifique la geometría de punto de entrada que contenga las propiedades x y y junto con la propiedad spatialReference. Si la propiedad spatialReference se define para todo el JSON, no es necesario que defina esta propiedad para cada geometría. Al hacerlo, se reduce el tamaño del JSON de entrada si la entrada tiene muchas entidades y también mejora el rendimiento. Esta propiedad no es necesaria si las coordenadas están en la referencia espacial predeterminada, WGS84. Si las coordenadas están en una referencia espacial diferente, debe especificar el Id. conocido de la referencia espacial (WKID). Consulte Utilizar referencias espaciales para buscar valores de WKID.

    Sugerencia:

    Se recomienda especificar explícitamente el valor de spatialReference y especificarlo para todo el JSON en lugar de para cada geometría individual.

  • attributes: especifique cada atributo como un par de clave-valor donde la clave es el nombre de un campo dado y el valor es el valor de atributo del campo correspondiente.

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>    
  }
  "features": [
    {
      "geometry": {
        "rings": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>],
            [<x11>,<y11>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>]
            [<x21>,<y21>]
          ]
        ]
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "rings": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>],
            [<x11>,<y11>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>],
            [<x21>,<y21>]
          ]
        ]
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ]
}

{
  "url": "<url>"
}

{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "rings": [
          [
            [-97.0634,32.8442],
            [-97.0554,32.84],
            [-97.0558,32.8327],
            [-97.0638,32.83],
            [-97.0634,32.8442]
          ]
        ]
      },
      "attributes": {
        "Name": "Flood zone",
        "BarrierType": 0
      }
    },
    {
      "geometry": {
        "rings": [
          [
            
            [-97.0803,32.8235],
            [-97.0776,32.8277],
            [-97.074,32.8254],
            [-97.0767,32.8227],
            [-97.0803,32.8235]
          ],
          [
            [-97.0871,32.8311],
            [-97.0831,32.8292],
            [-97.0853,32.8259],
            [-97.0892,32.8279],
            [-97.0871,32.8311]
            
          ]
        ]
      },
      "attributes": {
        "Name": "Severe weather zone",
        "BarrierType": 1,
        "ScaledTimeFactor": 3
      }
    }
  ]
}

{
  "url": "https://machine.domain.com/webadaptor/rest/services/Network/USA/MapServer/7/query?where=1%3D1&returnGeometry=true&f=json"
}

restrictions

Utilice este parámetro para especificar las restricciones que cumplirá el servicio. Una restricción representa una preferencia o un requisito de conducción. En la mayoría de casos, las restricciones ocasionan la prohibición de carreteras o rutas, pero también pueden hacer que se eviten o se les dé preferencia. Por ejemplo, utilizar la restricción Avoid Toll Roads dará como resultado una ruta que incluirá las carreteras de peaje solo si se requiere viajar por ellas para llegar a una parada. Utilice Height Restriction para trazar una ruta evitando cualquier lugar con una distancia al suelo que sea inferior a la altura del vehículo. Si el vehículo transporta materiales peligrosos, puede utilizar la restricción Any Hazmat Prohibited para impedir que los materiales se transporten por carreteras donde sea ilegal hacerlo.

Este valor de parámetro se especifica como una lista de nombres de restricción separados por comas. El valor none indica que no se utilizarán restricciones para buscar las rutas más cortas.

El servicio admite los siguientes nombres de restricción:

• Prohibidos todos los materiales peligrosos: los resultados no incluirán las carreteras en las que esté prohibido el transporte de cualquier tipo de material peligroso.

• Evitar carreteras VAO: el resultado evitará las carreteras designadas exclusivamente para los vehículos compartidos.

• Evitar carriles rápidos: los resultados evitarán las carreteras diseñadas como carriles rápidos.

• Evitar transbordadores: los resultados evitarán los transbordadores.

• Evitar puertas: los resultados evitarán las carreteras en las que haya puertas, como los accesos con clave o las entradas controladas por guardas.

• Evitar carreteras con acceso limitado: los resultados evitarán las carreteras que sean de acceso limitado.

• Evitar carreteras privadas: los resultados evitarán las carreteras que no sean de propiedad pública y no se mantengan con recursos públicos.

• Evitar las carreteras no aptas para peatones: los resultados evitarán las carreteras que no sean aptas para peatones.

• Evitar tramos de escalera: los resultados evitarán todos los tramos de escalera de una ruta adecuada para peatones.

• Evitar carreteras de peaje: los resultados evitarán todas las carreteras de peaje para automóviles.

• Evitar carreteras de peaje para camiones: los resultados evitarán todas las carreteras de peaje para camiones.

• Evitar carreteras con restricciones para camiones: los resultados evitarán las carreteras donde no estén permitidos los camiones excepto para hacer entregas.

• Evitar carreteras sin pavimentar: los resultados evitarán las carreteras que no estén pavimentadas (de tierra, de gravilla, etc.).

• Restricción de número de ejes: los resultados no incluirán carreteras en las que los camiones con el número especificado de ejes estén prohibidos. El número de ejes se puede especificar mediante el parámetro de restricción Número de ejes.

• Conduciendo autobús: los resultados no incluirán carreteras en las que estén prohibidos los autobuses. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Conduciendo taxi: los resultados no incluirán carreteras en las que estén prohibidos los taxis. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Conduciendo camión: los resultados no incluirán carreteras en las que estén prohibidos los camiones. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Conduciendo automóvil: los resultados no incluirán carreteras en las que estén prohibidos los automóviles. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Conduciendo vehículo de emergencia: los resultados no incluirán carreteras en las que estén prohibidos los vehículos de emergencia. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Restricción de altura: los resultados no incluirán las carreteras en las que la altura del vehículo supere la altura máxima permitida para la carretera. La altura del vehículo se puede especificar usando el parámetro de restricción Altura del vehículo (metros).

• Restricción de longitud de eje de dirección a eje trasero: los resultados no incluirán las carreteras en las que la longitud del vehículo supere la distancia máxima permitida entre el eje de dirección y el eje trasero para la carretera. La longitud entre el eje de dirección y el eje trasero se puede especificar usando el parámetro de restricción Longitud de eje de dirección a eje trasero del vehículo (metros).

• Restricción de longitud: los resultados no incluirán las carreteras en las que la longitud del vehículo supere la longitud máxima permitida para la carretera. La longitud del vehículo se puede especificar usando el parámetro de restricción Longitud del vehículo (metros).

• Preferido para peatones: los resultados utilizarán rutas preferidas adecuadas para la navegación para peatones.

• En moto: los resultados no incluirán carreteras en las que estén prohibidas las motocicletas. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Prohibidas las carreteras en obras: los resultados no incluirán carreteras que estén en obras.

• Prohibidos los camiones o tractores con uno o varios remolques: los resultados no incluirán las carreteras en las que estén prohibidos los camiones o tractores con uno o varios remolques.

• Prohibidos los vehículos de un solo eje: los resultados no incluirán carreteras en las que los vehículos de un solo eje estén prohibidos.

• Prohibidos los vehículos de doble eje: los resultados no incluirán carreteras en las que los vehículos de doble eje estén prohibidos.

• Prohibido el tráfico de paso: los resultados no incluyen las carreteras donde no se permita el tráfico de paso (tráfico no local).

• Restricción de camiones con remolques: los resultados no incluirán carreteras en las que los camiones con el número especificado de remolques estén prohibidos. El número de remolques del camión se puede especificar mediante el parámetro de restricción Número de remolques del camión.

• Usar rutas preferidas para materiales peligrosos: los resultados darán prioridad a las carreteras designadas para el transporte de materiales peligrosos.

• Usar rutas preferidas para camiones: los resultados darán prioridad a las carreteras que se hayan diseñado como rutas para camiones, como las que forman parte de la red nacional descrita en la National Surface Transportation Assistance Act de Estados Unidos, las carreteras que se hayan diseñado como rutas de camiones en un estado o una provincia, o aquellas que prefieran los camioneros cuando conducen por un área.

• A pie: los resultados no incluirán carreteras en las que estén prohibidos los peatones.

• Restricción de peso: los resultados no incluirán las carreteras en las que el peso del vehículo supere el peso máximo permitido para la carretera. El peso del vehículo se puede especificar usando el parámetro de restricción Peso del vehículo (kilogramos).

• Restricción de peso por eje: los resultados no incluirán las carreteras en las que el peso del vehículo por eje supere el peso máximo permitido por eje para la carretera. El peso por eje del vehículo se puede especificar usando el parámetro de restricción Peso por eje del vehículo (kilogramos).

• Restricción de ancho: los resultados no incluirán las carreteras en las que el ancho del vehículo supere el ancho máximo permitido para la carretera. El ancho del vehículo se puede especificar usando el parámetro de restricción Ancho del vehículo (metros).

El valor del parámetro de restricciones se especifica como una lista de nombres de restricción. Un valor de null indica que no se deben utilizar restricciones para buscar la ruta mejor, sino solo si travel_mode tiene el valor Custom.

restrictions=[Driving a Truck, Height Restriction, Length Restriction]

attribute_parameter_values

Utilice este parámetro para especificar valores adicionales requeridos por un atributo o restricción, como por ejemplo para especificar si la restricción prohíbe, evita o prefiere circular en carreteras restringidas. Si la restricción se ha ideado para evitar carreteras o darles preferencia, puede especificar en qué medida se deben evitar o se les debe dar preferencia usando este parámetro. Por ejemplo, puede elegir que nunca se usen carreteras de peaje, que se eviten en la medida de lo posible o que se les dé preferencia.

Puede especificar el parámetro attribute_parameter_values con una estructura JSON que represente a un conjunto de entidades. La estructura JSON puede incluir estas propiedades:

• features: especifique una matriz de entidades.

  • geometry: especifique la geometría de punto de entrada que contenga las propiedades x y y junto con la propiedad spatialReference. Si la propiedad spatialReference se define para todo el JSON, no es necesario que defina esta propiedad para cada geometría. Al hacerlo, se reduce el tamaño del JSON de entrada si la entrada tiene muchas entidades y también mejora el rendimiento. Esta propiedad no es necesaria si las coordenadas están en la referencia espacial predeterminada, WGS84. Si las coordenadas están en una referencia espacial diferente, debe especificar el Id. conocido de la referencia espacial (WKID). Consulte Utilizar referencias espaciales para buscar valores de WKID.

    Sugerencia:

    Se recomienda especificar explícitamente el valor de spatialReference y especificarlo para todo el JSON en lugar de para cada geometría individual.

  • attributes: especifique cada atributo como un par de clave-valor donde la clave es el nombre de un campo dado y el valor es el valor de atributo del campo correspondiente.

• url: especifique una solicitud de consulta REST para cualquier entidad, mapa o servicio de geoprocesamiento de ArcGIS Server que devuelva un conjunto de entidades JSON.

Cada entidad de la matriz de entidades representa un parámetro de atributos y contiene estos campos:

• attributes: especifique cada atributo como un par de clave-valor donde la clave es el nombre de un campo dado y el valor es el valor de atributo del campo correspondiente.

{
    "features": [
        {
            "attributes": {
                "<field1>": <value11>,
                "<field2>": <value12>,
                "<field3>": <value13>

            }
        },
        {
            "attributes": {
                "<field1>": <value21>,
                "<field2>": <value22>,
                "<field3>": <value13>
            }
        }
    ] 
}

attribute_parameter_values=
{
    "features": [
        {
            "attributes": {
                "AttributeName": "Height Restriction",
                "ParameterName": "Vehicle Height (meters)",
                "ParameterValue": 4.12
            }
        },
        {
            "attributes": {
                "AttributeName": "Weight Restriction",
                "ParameterName": "Vehicle Weight (kilograms)",
                "ParameterValue": 36287
            }
        },
        {
            "attributes": {
                "AttributeName": "Use Preferred Truck Routes",
                "ParameterName": "Restriction Usage",
                "ParameterValue": "PREFER_HIGH"
            }
        }
    ]
}

impedance

Especifique la impedancia.

La impedancia es un valor que cuantifica el viaje a lo largo de la red de transporte. La distancia de viaje es un ejemplo de impedancia; cuantifica la longitud de caminos y segmentos de la carretera. Del mismo modo, el tiempo de conducción (el tiempo típico que lleva conducir un coche a lo largo de un segmento de carretera), es un ejemplo de impedancia. Los tiempos de conducción pueden variar según el tipo de vehículo (por ejemplo, el tiempo que un camión tarda en viajar a lo largo de una ruta suele ser más largo que el de un coche) por lo que pueden existir muchos valores de impedancia que representan los tiempos de viaje para distintos tipos de vehículos. Los valores de la impedancia también pueden variar con el tiempo; el tráfico en directo y típico hace referencia a los valores de la impedancia dinámica. Cada recorrido a pie y segmento de carretera almacena al menos un valor de impedancia. Al realizar un análisis de red, los valores de impedancia se utilizan para calcular los mejores resultados, como buscar la ruta más corta (la ruta que minimiza la impedancia) entre dos puntos.

El parámetro impedance se puede especificar con estos valores:

• TravelTime: se utilizan datos de tráfico históricos y en directo. Esta opción resulta útil para modelar el tiempo que tardan los automóviles en desplazarse por carreteras a una hora concreta del día utilizando datos de velocidad del tráfico en directo si están disponibles. Si utiliza TravelTime, si lo desea puede definir el parámetro de atributos TravelTime::Vehicle Maximum Speed (km/h) para especificar los límites físicos de la velocidad a la que el vehículo es capaz de desplazarse.
• Minutos: no se utilizan datos de tráfico en directo, sino velocidades medias históricas de los datos de automóviles.
• TruckTravelTime: se utilizan datos de tráfico históricos y en directo, pero se establece una velocidad máxima al límite de velocidad especificado para camiones. Resulta útil para modelar el tiempo que tardan los camiones en desplazarse por carreteras a una hora concreta del día. Si utiliza TruckTravelTime, si lo desea puede definir el parámetro de atributos TruckTravelTime::Vehicle Maximum Speed (km/h) para especificar los límites físicos de la velocidad a la que el camión es capaz de desplazarse.
• TruckMinutes: no utiliza datos de tráfico en directo, pero sí utiliza las velocidades más bajas del promedio histórico para automóviles y los límites de velocidad permitidos para camiones.
• WalkTime: el valor predeterminado es una velocidad de 5 km/h en todas las carreteras y caminos, pero se puede configurar mediante el parámetro de atributos WalkTime::Walking Speed (km/h).
• Millas: las mediciones de longitud de carreteras se almacenan en millas y se pueden utilizar para realizar análisis según la distancia más corta.
• Kilómetros: las mediciones de longitud de carreteras se almacenan en kilómetros y se pueden utilizar para realizar análisis según la distancia más corta.

Si elige una impedancia basada en el tiempo, como TravelTime, TruckTravelTime, Minutes, TruckMinutes o WalkTime, el parámetro measurement_units se debe configurar con un valor basado en el tiempo; si prefiere una impedancia basada en la distancia, como Miles, Kilometers o measurement_units, deben estar basadas en la distancia.

save_output_network_analysis_layer

Use este parámetro para especificar si el servicio debe guardar la configuración del análisis como un archivo de capa de análisis de red. No es posible trabajar directamente con este archivo, aunque lo abra en una aplicación de ArcGIS Desktop como ArcGIS Pro. Se debe enviar al Soporte técnico de Esri para diagnosticar la calidad de los resultados devueltos por el servicio.

• true: guarda el archivo de capas de análisis de red. El archivo se puede descargar desde la dirección URL proporcionada como parte del parámetro output_network_analysis_layer.
• false: no guarda el archivo de capas de análisis de red.

El valor predeterminado es false.

overrides

time_impedance

El valor de impedancia basada en el tiempo representa el tiempo de viaje a lo largo de segmentos de carretera o en otras partes de la red de transporte.

• Minutes
• TravelTime
• WalkTime
• TruckMinutes
• TruckTravelTime

distance_impedance

El valor de impedancia basada en la distancia representa la distancia de viaje a lo largo de segmentos de carretera o en otras partes de la red de transporte.

• Miles
• Kilometers

polygon_detail

Especifica el nivel de detalle de los polígonos de salida.

• Estándar: se crearán polígonos con un nivel de detalle estándar. Los polígonos estándar se generan con rapidez y son bastante precisos, pero la calidad se deteriora ligeramente a medida que se acerca a los bordes de los polígonos de área de servicio. Esta es la opción predeterminada.
• Generalizado: se crearán polígonos generalizados utilizando la jerarquía presente en la fuente de datos de red para generar resultados rápidamente. Los polígonos generalizados tienen menor calidad que los polígonos de precisión estándar o alta.
• Alta: se crearán polígonos con el máximo nivel de detalle. Pueden existir agujeros en el polígono; representan islas de elementos de red (como calles) a los que no se ha podido llegar sin rebasar la impedancia de valor límite o debido a restricciones de viaje. Esta opción se debería utilizar para aplicaciones en las que es importante obtener resultados precisos.

Si su análisis abarca un área urbana con una red de calles semejante a una cuadrícula, la diferencia entre los polígonos generalizados y estándares será mínima. Sin embargo, para los caminos rurales y de montaña, los polígonos estándares y detallados pueden presentar resultados significativamente más precisos que los polígonos generalizados.

output_type

Especifica el tipo de salida que se generará. La salida del área de servicio puede constar de entidades de línea que representan las carreteras a las que se puede llegar antes de sobrepasar los valores límite o entidades poligonales que abarquen estas líneas (representan el área a la que se puede llegar).

• Polígonos: la salida del área de servicio solo contendrá polígonos. Esta es la opción predeterminada.
• Líneas: la salida del área de servicio solo contendrá líneas.
• Polígonos y líneas: la salida del área de servicio contendrá polígonos y líneas.

output_format

Especifica el formato en el que se devolverán las entidades de salida.

• Conjunto de entidades: las entidades de salida se generarán como tablas y clases de entidad. Esta es la opción predeterminada.
• Archivo JSON: las entidades de salida se devolverán como un archivo comprimido que contiene la representación JSON de las salidas. Si se especifica esta opción, la salida será un archivo único (con una extensión .zip) que contiene uno o varios archivos JSON (con una extensión .json) para cada una de las salidas que crea el servicio.
• Archivo GeoJSON: las entidades de salida se devolverán como un archivo comprimido que contiene la representación GeoJSON de las salidas. Si se especifica esta opción, la salida será un archivo único (con una extensión .zip) que contiene uno o varios archivos GeoJSON (con una extensión .geojson) para cada una de las salidas que crea el servicio.

env:outSR

Utilice este parámetro para especificar la referencia espacial de las geometrías, como entidades de líneas o puntos, que devuelve un servicio.

El valor del parámetro se puede especificar como un Id. conocido (WKID) para la referencia espacial. Consulte Utilizar referencias espaciales para buscar valores de WKID.

Muchos de los mapas base proporcionados por ArcGIS Online están en la referencia espacial Web Mercator (WKID 102100). Al especificar env:outSR=102100 se devuelven las geometrías de la referencia espacial Web Mercator, que se pueden dibujar sobre los mapas base.

ignore_network_location_fields

Especifica si los campos de ubicación de red se tendrán en cuenta al localizar entradas como paradas o instalaciones en la red.

• true: los campos de ubicación de red no se tendrán en cuenta al localizar las entradas en la red. En su lugar, las entradas siempre se localizarán realizando una búsqueda espacial.
• false: los campos de ubicación de red se tendrán en cuenta al localizar las entradas en la red.

El valor predeterminado es false.

ignore_invalid_locations

Especifica si se ignorarán las ubicaciones de entrada no válidas.

• true—

  Las ubicaciones de red no ubicadas se ignorarán y el análisis se ejecutará únicamente utilizando ubicaciones de red válidas. El análisis también continuará si las ubicaciones están en elementos no transitables o tienen otros errores. Esta opción es útil si usted sabe que las ubicaciones de red no son todas correctas, pero desea ejecutar el análisis con las ubicaciones de red que son válidas. Esta es la opción predeterminada.

• false—

  Las ubicaciones no válidas no se ignorarán. No ejecute el análisis si hay ubicaciones no válidas. Corrija las ubicaciones no válidas y vuelva a ejecutar el análisis.

locate_settings

Use este parámetro para especificar configuraciones que afecten a cómo se ubican las entradas, como la máxima distancia de búsqueda que se usa al localizar las entradas en la red, o las fuentes de red que se usan para localizar. Para restringir la ubicación en una parte del origen, puede especificar una cláusula WHERE para un origen.

Más información sobre la localización de entradas

El valor de parámetro se especifica como un objeto JSON. El objeto JSON le permite especificar un JSON de localizador para todas las entidades de entrada en el análisis o puede especificar una excepción para una entrada concreta. La excepción le permite tener diferentes ajustes para cada entrada de análisis. Por ejemplo, es posible no permitir que las paradas se ubiquen en las rampas de autopista y permitir que las barreras de punto se ubiquen en las rampas de autopista.

El objeto JSON del localizador tiene las siguientes propiedades:

• tolerance y toleranceUnits: permite controlar la distancia máxima de búsqueda al localizar las entradas. Si no se encuentra ninguna ubicación de red válida dentro de esta distancia, la entidad de entrada se considerará no ubicada. Una pequeña tolerancia de búsqueda disminuye la probabilidad de ubicarse en la calle equivocada, pero aumenta la probabilidad de no encontrar ninguna ubicación de red válida. El valor del parámetro toleranceUnits se puede especificar como uno de los siguientes valores:
  • esriCentimeters
  • esriDecimalDegrees
  • esriDecimeters
  • esriFeet
  • esriInches
  • esriIntFeet
  • esriIntInches
  • esriIntMiles
  • esriIntNauticalMiles
  • esriIntYards
  • esriKilometers
  • esriMeters
  • esriMiles
  • esriMillimeters
  • esriNauticalMiles
  • esriYards
• sources: le permite controlar qué fuente de red se puede utilizar para la ubicación. Por ejemplo, puede configurar el análisis para localizar entradas en calles, pero no en aceras. La lista de posibles fuentes en las que localizar es específica del dataset de red al que hace referencia este servicio. Solo se usan para ubicar las fuentes que estén presentes en la matriz de fuentes. Es posible especificar una cláusula where en cada fuente especificada en la matriz de fuentes para restringir aún más la localización en ese origen que coincida con ciertas características mediante una expresión SQL. Por ejemplo, puede configurar el análisis para que localice las entradas solo en las entidades de calles que coincidan con determinadas clases de carreteras, como evitar las rampas de las autopistas. Las fuentes se especifican como una matriz de objetos, cada uno con las siguientes propiedades:
  • name: nombre de la clase de entidad de la fuente de red que se puede usar para ubicar entradas.
  • where: una expresión SQL en la clase de entidad de fuente de red.
• allowAutoRelocate: permite controlar si las entradas con campos de ubicación de red existentes se pueden reubicar automáticamente al solucionar para garantizar que se disponga de campos de ubicación enrutables y válidos para el análisis. Si el valor es true, los puntos ubicados en elementos de red restringidos y los puntos afectados por las barreras se reubicarán en la ubicación enrutable más cercana. Si el valor es false, los campos de ubicación de red se utilizarán como están, aunque los puntos no sean accesibles, y esto puede hacer que la resolución falle. Aunque el valor sea false, las entradas sin campos de ubicación o campos de ubicación incompletos se localizarán durante la operación de resolución.

{
    "default": {
        "tolerance": <value>,
        "toleranceUnits": "<unit>",
        "allowAutoRelocate": true | false,
        "sources": [{
            "name": "<sourceName>",
            "where": "<whereClause>"
        }]
    },
    "overrides": {
        "facilities": {
            "tolerance": <value>,
            "toleranceUnits": "<unit>",
            "allowAutoRelocate": true | false,
            "sources": [{
                "name": "<sourceName>",
                "where": "<whereClause>"
            }]
        },
        "point_barriers": {
            "tolerance": <value>,
            "toleranceUnits": "<unit>",
            "allowAutoRelocate": true | false,             
            "sources": [{
                "name": "<sourceName>",
                "where": "<whereClause>"
            }]
        },
        "line_barriers": {
            "allowAutoRelocate": true | false,       
            "sources": [{
                "name": "<sourceName>",
                "where": "<whereClause>"
            }]
        },
        "polygon_barriers": {
            "allowAutoRelocate": true | false,  
            "sources": [{
                "name": "<sourceName>",
                "where": "<whereClause>"
            }]
        }
    }
}

{
  "default": {
    "tolerance": 500,
    "toleranceUnits": "esriMeters",
    "allowAutoRelocate": true,
    "sources": [
      {
        "name": "Routing_Streets"
      }
    ]
  }
}

{
    "default": {
        "tolerance": 20,
        "toleranceUnits": "esriKilometers",
        "allowAutoRelocate": true,
        "sources": [{
            "name": "Routing_Streets"
        }]
    },
    "overrides": {
        "facilities": {
            "sources": [{
                "name": "Routing_Streets",
                "where": "ROAD_CLASS <> 3"
            }]
        }
    }
}

{
    "default": {
        "tolerance": 20,
        "toleranceUnits": "esriKilometers",
        "allowAutoRelocate": true,
        "sources": [{
            "name": "Routing_Streets"
        }]
    },
    "overrides": {
        "point_barriers": {
            "sources": [{
                "name": "Routing_ND_Junctions"
            }]
        }
    }
}

accumulate_attributes

Lista de los atributos de coste que se acumularán durante el análisis. Estos atributos acumulados solo se utilizan como referencia; el solucionador solo utiliza el atributo de coste empleado en el modo de viaje indicado al solucionar el análisis.

Para cada atributo de coste acumulado, se rellena un campo Total_[Cost Attribute Name]_[Units] en las salidas creadas desde la herramienta.

service_areas

Use this parameter to get the area that can be reached from the input location within a given travel time or travel distance. The polygon_overlap_type, polygons_for_multiple_facilities, polygon_trim_distance, and polygon_simplification_tolerance parameters influence the shape of the output service areas. The service area geometries are returned in the spatial reference specified in the env:outSR parameter.

The following table provides a description of the fields that are returned for each service area:

{
  "paramName": "service_areas",
  "dataType": "GPFeatureRecordSetLayer",
  "value": {
    "displayFieldName": "",
    "geometryType": "esriGeometryPolygon",
    "spatialReference": {
      "wkid": <wkid>,
      "latestWkid": <wkid>
    },
    "fields": [
      {
        "name": "<field1Name>",
        "type": "<field1Type>",
        "alias": "<field1Alias>",
        "length": "<field1Length>"
      },
      {
        "name": "<field2Name>",
        "type": "<field2Type>",
        "alias": "<field2Alias>",
        "length": "<field2Length>"
      }
    ],
    "features": [
      {
        "geometry": {
          "rings": [
            [
              [
                <x11>,
                <y11>
              ],
              [
                <x12>,
                <y12>
              ]
              [
                <x11>,
                <y11>
              ]
            ],
            [
              [
                <x21>,
                <y21>
              ],
              [
                <x22>,
                <y22>
              ],
              [
                <x21>,
                <y21>
              ]
            ]
          ]
        },
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        }
      },
      {
        "geometry": {
          "rings": [
            [
              [
                <x11>,
                <y11>
              ],
              [
                <x12>,
                <y12>
              ]
              [
                <x11>,
                <y11>
              ]
            ],
            [
              [
                <x21>,
                <y21>
              ],
              [
                <x22>,
                <y22>
              ],
              [
                <x21>,
                <y21>
              ]
            ]
          ]
        },
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        }
      }
    ],
    "exceededTransferLimit": <true|false>
  }
}

{
  "paramName": "service_areas",
  "dataType": "GPFeatureRecordSetLayer",
  "value": {
    "displayFieldName": "",
    "geometryType": "esriGeometryPolygon",
    "spatialReference": {
      "wkid": 4326,
      "latestWkid": 4326
    },
    "fields": [
      {
        "name": "ObjectID",
        "type": "esriFieldTypeOID",
        "alias": "ObjectID"
      },
      {
        "name": "FacilityID",
        "type": "esriFieldTypeInteger",
        "alias": "FacilityID"
      },
      {
        "name": "Name",
        "type": "esriFieldTypeString",
        "alias": "Name",
        "length": 128
      },
      {
        "name": "FromBreak",
        "type": "esriFieldTypeDouble",
        "alias": "FromBreak"
      },
      {
        "name": "ToBreak",
        "type": "esriFieldTypeDouble",
        "alias": "ToBreak"
      },
      {
        "name": "FacilityOID",
        "type": "esriFieldTypeInteger",
        "alias": "FacilityOID"
      },
      {
        "name": "FacilityName",
        "type": "esriFieldTypeString",
        "alias": "Name",
        "length": 128
      },
      {
        "name": "Shape_Length",
        "type": "esriFieldTypeDouble",
        "alias": "Shape_Length"
      },
      {
        "name": "Shape_Area",
        "type": "esriFieldTypeDouble",
        "alias": "Shape_Area"
      }
    ],
    "features": [
      {
        "attributes": {
          "ObjectID": 1,
          "FacilityID": 1,
          "Name": "Facility 1 : 5 - 10",
          "FromBreak": 5,
          "ToBreak": 10,
          "FacilityOID": 1,
          "FacilityName": "Facility 1",
          "Shape_Length": 0.62070029717646258,
          "Shape_Area": 0.0033515430829082126
        },
        "geometry": {
          "rings": [
            [
              [
                -0.17744255103286832,
                51.558202743861614
              ],
              [
                -0.17631721496746877,
                51.557527541862612
              ]
            ],
            [
              [
                -0.19568443269037061,
                51.539964676228863
              ],
              [
                -0.19658470172254283,
                51.53816032413971
              ]
            ]
          ]
        }
      },
      {
        "attributes": {
          "ObjectID": 2,
          "FacilityID": 1,
          "Name": "Facility 1 : 0 - 5",
          "FromBreak": 0,
          "ToBreak": 5,
          "FacilityOID": 1,
          "FacilityName": "Facility 1",
          "Shape_Length": 0.16771059350061351,
          "Shape_Area": 0.00094631728859383775
        },
        "geometry": {
          "rings": [
            [
              [
                -0.18937839999313155,
                51.540412800310548
              ],
              [
                -0.18847760036089767,
                51.54018760017766
              ]
            ]
          ]
        }
      }
    ],
    "exceededTransferLimit": false
  }
}

output_facilities

Ofrece acceso a los atributos de las instalaciones que se usan en el análisis del área de servicio. Puede utilizar los atributos de este tipo de datos, por ejemplo, el campo Status, para determinar el motivo por el que una instalación no se utilizó en el análisis.

The data type supports the fields listed below. In addition to these fields, the data type also includes all the fields from the input feature class used as facilities for the analysis.

solve_succeeded

Use this parameter to determine whether the service successfully found the service areas. The error messages for the failure can be obtained by making a request to get the status of the job.

The solve_succeeded parameter is returned as a JSON feature set with the following syntax:

{
  "paramName": "solve_succeeded",
  "dataType": "GPBoolean",
  "value": <true | false>
}

The following shows an example of the solve_succeeded parameter:

{
  "paramName": "solve_succeeded",
  "dataType": "GPBoolean",
  "value": true
}

Calculate 5-, 10-, and 15-minute drive-time polygons around store locations

This example shows how to calculate 5-, 10-, and 15-minute drive-time polygons around a store. The store location is specified in the facilities parameter. The drive-time polygons must be drawn on an ArcGIS Online or ArcGIS Enterprise basemap that uses the Web Mercator spatial reference. Therefore, the env:outSR parameter is specified with a value of 102100 to return polygon geometries in the appropriate spatial reference. The default values for all the other parameters are appropriate for this request and are not specified.

https://<gpservice-url>/GenerateServiceAreas/submitJob?facilities={"features":[{"geometry":{"x":-122.253,"y":37.757},
"attributes":{"Name":"Store5689"}}]}&env:outSr=102100&f=json&token=<yourToken>

https://<gpservice-url>/GenerateServiceAreas/submitJob?facilities=%7B%22features%22:%5B%7B%22geometry%22:%7B%22x%22:-122.253,%22y%22:37.757%7D,
%22attributes%22:%7B%22Name%22:%22Store5689%22%7D%7D%5D%7D&env:outSr=102100&f=json&token=<yourToken>

{
  "jobId": "j54d8cee6384e45a594cc9f8fbc4697f3",
  "jobStatus": "esriJobSubmitted"
}

Query job status

The job ID obtained from the response of the first request can be queried periodically to determine the status of the job.

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>?f=json&token=<yourToken>

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>?f=json&token=<yourToken>

{
  "jobId": "j54d8cee6384e45a594cc9f8fbc4697f3",
  "jobStatus": "esriJobSucceeded",
  "results": {
    "Service_Areas": {
      "paramUrl": "results/Service_Areas"
    },
    "Solve_Succeeded": {
      "paramUrl": "results/Solve_Succeeded"
    }
  },
  "inputs": {
    "Facilities": {
      "paramUrl": "inputs/Facilities"
    },
    "Break_Values": {
      "paramUrl": "inputs/Break_Values"
    },
    "Break_Units": {
      "paramUrl": "inputs/Break_Units"
    },
    "Analysis_Region": {
      "paramUrl": "inputs/Analysis_Region"
    },
    "Travel_Direction": {
      "paramUrl": "inputs/Travel_Direction"
    },
    "Time_of_Day": {
      "paramUrl": "inputs/Time_of_Day"
    },
    "Use_Hierarchy": {
      "paramUrl": "inputs/Use_Hierarchy"
    },
    "UTurn_at_Junctions": {
      "paramUrl": "inputs/UTurn_at_Junctions"
    },
    "Polygons_for_Multiple_Facilities": {
      "paramUrl": "inputs/Polygons_for_Multiple_Facilities"
    },
    "Polygon_Overlap_Type": {
      "paramUrl": "inputs/Polygon_Overlap_Type"
    },
    "Detailed_Polygons": {
      "paramUrl": "inputs/Detailed_Polygons"
    },
    "Polygon_Trim_Distance": {
      "paramUrl": "inputs/Polygon_Trim_Distance"
    },
    "Polygon_Simplification_Tolerance": {
      "paramUrl": "inputs/Polygon_Simplification_Tolerance"
    },
    "Point_Barriers": {
      "paramUrl": "inputs/Point_Barriers"
    },
    "Line_Barriers": {
      "paramUrl": "inputs/Line_Barriers"
    },
    "Polygon_Barriers": {
      "paramUrl": "inputs/Polygon_Barriers"
    },
    "Restrictions": {
      "paramUrl": "inputs/Restrictions"
    },
    "Attribute_Parameter_Values": {
      "paramUrl": "inputs/Attribute_Parameter_Values"
    }
  },
  "messages": []
}

Return the output service areas

Because the job succeeded, you can make a request to return the service areas from the service_areas output parameter.

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/results/service_areas?f=pjson&token=<yourToken>

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/results/service_areas?f=pjson&token=<yourToken>

{
  "paramName": "Service_Areas",
  "dataType": "GPFeatureRecordSetLayer",
  "value": {
    "displayFieldName": "",
    "geometryType": "esriGeometryPolygon",
    "spatialReference": {
      "wkid": 102100,
      "latestWkid": 3857
    },
    "fields": [
      {
        "name": "ObjectID",
        "type": "esriFieldTypeOID",
        "alias": "ObjectID"
      },
      {
        "name": "FacilityID",
        "type": "esriFieldTypeInteger",
        "alias": "FacilityID"
      },
      {
        "name": "Name",
        "type": "esriFieldTypeString",
        "alias": "Name",
        "length": 128
      },
      {
        "name": "FromBreak",
        "type": "esriFieldTypeDouble",
        "alias": "FromBreak"
      },
      {
        "name": "ToBreak",
        "type": "esriFieldTypeDouble",
        "alias": "ToBreak"
      },
      {
        "name": "FacilityOID",
        "type": "esriFieldTypeInteger",
        "alias": "FacilityOID"
      },
      {
        "name": "FacilityName",
        "type": "esriFieldTypeString",
        "alias": "Name",
        "length": 128
      },
      {
        "name": "Shape_Length",
        "type": "esriFieldTypeDouble",
        "alias": "Shape_Length"
      },
      {
        "name": "Shape_Area",
        "type": "esriFieldTypeDouble",
        "alias": "Shape_Area"
      }
    ],
    "features": [
      {
        "attributes": {
          "ObjectID": 1,
          "FacilityID": 1,
          "Name": "Store5689 : 10 - 15",
          "FromBreak": 10,
          "ToBreak": 15,
          "FacilityOID": 1,
          "FacilityName": "Store5689",
          "Shape_Length": 186829.46238855206,
          "Shape_Area": 101157487.56126754
        },
        "geometry": {
          "rings": [
            [
              [
                -13609000.5407,
                4557625.0921000019
              ],
              [
                -13609011.581599999,
                4557630.4697000012
              ]
            ],
            [
              [
                -13609000.5407,
                4557625.0921000019
              ],
              [
                -13608886.309799999,
                4557567.0144999996
              ]
            ]          
          ]
        }
      },
      {
        "attributes": {
          "ObjectID": 2,
          "FacilityID": 1,
          "Name": "Store5689 : 5 - 10",
          "FromBreak": 5,
          "ToBreak": 10,
          "FacilityOID": 1,
          "FacilityName": "Store5689",
          "Shape_Length": 98556.221615700371,
          "Shape_Area": 45188876.257299371
        },
        "geometry": {
          "rings": [
            [
              [
                -13610967.0956,
                4551187.9716000035
              ],
              [
                -13610942.041099999,
                4551061.1401000023
              ]
            ],
            [
              [
                -13611418.2863,
                4546620.322300002
              ],
              [
                -13611451.621300001,
                4546606.3554000035
              ]
            ]
          ]
        }
      },
      {
        "attributes": {
          "ObjectID": 3,
          "FacilityID": 1,
          "Name": "Store5689 : 0 - 5",
          "FromBreak": 0,
          "ToBreak": 5,
          "FacilityOID": 1,
          "FacilityName": "Store5689",
          "Shape_Length": 21281.354678039555,
          "Shape_Area": 11623189.162529219
        },
        "geometry": {
          "rings": [
            [
              [
                -13609262.337400001,
                4547603.4253999963
              ],
              [
                -13609237.2831,
                4547476.6374000013
              ]
            ]
          ]
        }
      }
    ],
    "exceededTransferLimit": false
  }
}

Job execution

After the initial request is submitted, you can make a request of the following form to get the status of the job:

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/?token=<yourToken>&returnMessages=true&f=json

Below is a sample JSON syntax during job execution:

{
  "jobId": "<jobId>",
  "jobStatus": "<jobStatus>",
  "messages": [
    {
      "type": "<type1>",
      "description": "<description1>"
    },
    {
      "type": "<type2>",
      "description": "<description2>"
    }
  ]
}

While a job is executing, you can cancel it by making a request of the following form:

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/cancel?token=<yourToken>&f=json

Job completion

After the successful completion of the job, you can make a request of the following form to retrieve the outputs. Refer to the Output parameters section for more information on how to interpret the solution provided by the service.

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/results/<output_parameter_name>?token=<yourToken>&f=json

You can also retrieve the value for any input parameter by making a request of the following form:

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/inputs/<inputParameterName>?token=<yourToken>&f=json