os_map_export_roads
Export complete road overlay artifacts for chosen roads or area-of-interest selections, bundling all upstream map pages and semantic road parts into a single output.
Instructions
Export complete road overlay artifacts server-side from road numbers and/or selectionSpec-derived AOIs, including all upstream pages and semantic parts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bbox | No | Optional fallback WGS84 bbox [minLon,minLat,maxLon,maxLat]. Prefer selectionSpec for postcode, UPRN, GSS-code, or polygon AOIs. | |
| tool | No | ||
| roads | No | ||
| collection | No | Optional default NGD collection id. | |
| forceRefresh | No | ||
| outputFormat | No | geojson_bundle | |
| selectionSpec | No | Selector-driven AOI definition. Supports postcode, uprn, gss_code, and polygon selectors plus uprnOverrides. | |
| derivationMode | No | exact | |
| anchorBufferMeters | No | Optional buffer applied around resolved building anchors before fetching RoadLinks. | |
| postalDeliveryOnly | No | ||
| simplifyToleranceMeters | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aoi | No | ||
| bbox | No | ||
| parts | No | ||
| roads | No | ||
| cached | No | ||
| format | Yes | ||
| complete | Yes | ||
| delivery | Yes | ||
| exportId | Yes | ||
| collection | No | ||
| primaryUri | No | ||
| requestHash | No | ||
| resourceUri | Yes | ||
| featureCounts | Yes | ||
| sourcePagesFetched | No |