Context Navigation

← Previous Change
Wiki History
Next Change →

Changes between Version 4 and Version 25 of Help/RemoteControlCommands

Timestamp:: (multiple changes)
Author:: (multiple changes)
Comment:: (multiple changes)

Legend:

: Unmodified
: Added
: Removed
: Modified

Help/RemoteControlCommands

-              v4
+              v25
 == List of Commands ==
 A complete list of commands and mandatory/optional parameters is shown at http://127.0.0.1:8111/ (when JOSM is running).
+=== {{{load_and_zoom}}} ===
+=== {{{load_and_zoom}}} ===#load_and_zoom
 Instructs JOSM to download a bounding box from the API, zoom to the downloaded area and optionally select one or more objects.
 {{{
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
+|| `bottom` || R || Minimum latitude ||
+|| `top` || R || Maximum latitude ||
+|| `left` || R || Minimum longitude ||
+|| `right` || R || Maximum longitude ||
+|| `new_layer` || O || If '''true''', downloads to a new layer ||
+|| `addtags` || O || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+|| `select` || O || Comma-separated list of objects that should be selected. Object specifiers are combinations of the words "way", "node", or "relation", and the numerical object id. Example: {{{select=way38473,node12399,node54646}}} ||
+|| `zoom_mode` || O || '''download''' | '''selection''', defaults to selection ||
+|| `changeset_comment` || O || Comment of the changeset ||
+|| `changeset_source` || O || Source of the changeset ||
+|| `search` || O || Search objects in the current data layer. See [wiki:/Help/Action/Search Search] ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `bottom` ||  R  || Minimum latitude ||
+|| `top` ||  R  || Maximum latitude ||
+|| `left` ||  R  || Minimum longitude ||
+|| `right` ||  R  || Maximum longitude ||
+|| `new_layer` ||  O  || If '''true''', downloads to a new layer. (Overwrites user preference, see #19308) ||
+|| `layer_name` ||  O  || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+|| `layer_locked` ||  O  || Only valid when the data is loaded in a new layer; If '''true''', new layer is [wikitr:/Help/Action/LockedLayer locked] ||
+|| `download_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' , download is [wikitr:/Help/Action/BlockDownload blocked] ||
+|| `upload_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [wikitr:/Help/Action/EncourageDiscourageUpload blocked or discouraged] ||
+|| `addtags` ||  O  || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+|| `select` ||  O  || Comma-separated list of objects that should be selected. Object specifiers are combinations of the words "way", "node", or "relation", and the numerical object id. Example: {{{select=way38473,node12399,node54646}}}. Since r13212 the special value **currentselection** let JOSM keep its previous selection. ||
+|| `zoom_mode` ||  O  || '''download''' | '''selection''', defaults to selection ||
+|| `changeset_comment` ||  O  || Comment of the changeset ||
+|| `changeset_source` ||  O  || Source of the changeset ||
+|| `changeset_hashtags` ||  O  || Hashtags of the changeset ''(since r13109)'' ||
+|| `changeset_tags` ||  O  || Optional parameter to add changeset tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". This command uses the same syntax as the [#addtags addtags] parameter. `changeset_comment` and `changeset_source` currently override the `comment` and `source` tags passed in this parameter, but this may change in the future. ''(since r15316)'' ||
+|| `search` ||  O  || Search objects in the current data layer. See [wikitr:/Help/Action/Search Search] ||
 ==== Example ====
 Start JOSM (don't forget to enable the !RemoteControl feature), then click on:
 …
 JOSM should now load an area in the German Schwarzwald and have the specified node selected.
 === {{{zoom}}} ===
 …
 **Hint**: This command can also be used to select objects only. Just enter a small arbitrary area to the left..bottom entries and add the object list to the select= option.
 === {{{import}}} ===
 Instructs JOSM to download the specified OSM file and add it to the current data set.
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
+|| `url` || R || The Request URL, including patterns. Must be the last parameter, everything after "&url=" is interpreted as URL, even if it contains "&" characters. ||
+|| `new_layer` || O || If '''true''', downloads to a new layer ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `url` ||  R  || The Request URL, including patterns. Must be the last parameter, everything after "&url=" is interpreted as URL, even if it contains "&" characters. ||
+|| `new_layer` ||  O  || If '''true''', downloads to a new layer. (Overwrites user preference, see #19308) ||
+|| `layer_name` ||  O  || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+|| `layer_locked` ||  O  || Only valid when the data is loaded in a new layer; If '''true''', new layer is [wikitr:/Help/Action/LockedLayer locked] ||
+|| `download_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' , download is [wikitr:/Help/Action/BlockDownload blocked] ||
+|| `upload_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [wikitr:/Help/Action/EncourageDiscourageUpload blocked or discouraged] ||
+|| `changeset_tags` ||  O  || Optional parameter to add changeset tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". This command uses the same syntax as the [#addtags addtags] parameter. First available in r16324. ||
 === {{{load_data}}} ===
+(since version 1.6)
+''(since version 1.6)''
 Instruct JOSM to load OSM data, directly encoded in the URL, instead of coming from an external file. This is only suited for smaller data (some browsers limit the maximum URL length), but it is faster (since no download is required), and in many cases where dynamically generated data is needed, it's easier to generate.
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
+|| `data` || R || The XML data to load, this should be URL encoded in a way that also encodes the special characters &, = and ? to resp. %26, %3D and %3F. The JS [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeUriComponent()] method provides this functionality out of the box. ||
+|| `new_layer` || O || Chose to load the data in a new layer ||
+|| `mime_type` || O || Mime type of the data, by default this is "application/x-osm+xml", which is currently the only supported mime type, but in the future other mime types could be supported ||
+|| `layer_name` || O || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `data` ||  R  || The XML data to load, this should be URL encoded in a way that also encodes the special characters &, = and ? to resp. %26, %3D and %3F. The JS [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeUriComponent()] method provides this functionality out of the box. ||
+|| `new_layer` ||  O  || Choose to load the data in a new layer. (Overwrites user preference, see #19308) ||
+|| `mime_type` ||  O  || Mime type of the data, by default this is "application/x-osm+xml", which is currently the only supported mime type, but in the future other mime types could be supported ||
+|| `layer_name` ||  O  || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+|| `layer_locked` ||  O  || Only valid when the data is loaded in a new layer; If '''true''', new layer is [wikitr:/Help/Action/LockedLayer locked] ||
+|| `download_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' , download is [wikitr:/Help/Action/BlockDownload blocked] ||
+|| `upload_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [wikitr:/Help/Action/EncourageDiscourageUpload blocked or discouraged] ||
 === {{{open_file }}} ===
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
 || `filename` || R || The local file to open in JOSM (Ie: /tmp/test.osm) ||
+=== {{{imagery}}} ===
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `filename` ||  R  || The local file to open in JOSM (Ie: /tmp/test.osm) ||
+=== {{{imagery}}} ===#imagery
 Instructs JOSM to add an imagery (WMS/TMS) layer.
 {{{
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
+|| `url` || R || The Request URL, including patterns. Must be the last parameter, everything after "&url=" is interpreted as URL, even if it contains "&" characters.  ||
+|| `title` || O || The display name of the layer ||
+|| `type` || O || Type of the layer. Possible values are `wms`, `tms` and `bing` [[BR]] (since !RemoteControl Version 1.3) ||
+|| `cookies` || O ||  ||
+|| `min_zoom` || O || The minimum zoom level [[BR]] (since !RemoteControl Version 1.4) ||
+|| `max_zoom` || O || The maximum zoom level. For higher scales, the images of the maximum level is enlarged [[BR]] (since !RemoteControl Version 1.4) ||
+mandatory parameters: url
+optional parameters: title, type, cookies, min_zoom, max_zoom
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `url` ||  R or `id`  || The Request URL, including patterns. Must be the last parameter, everything after "&url=" is interpreted as URL, even if it contains "&" characters.  ||
+|| `id` ||  R or `url`  || The imagery ID in JOSM, see [[Maps]] (since r17655).  ||
+|| `title` ||  O  || The display name of the layer ||
+|| `type` ||  O  || Type of the layer. Possible values are `wms`, `tms` and `bing` ''(defaults to `wms`, since !RemoteControl Version 1.3)'' ||
+|| `cookies` ||  O  ||  ||
+|| `min_zoom` ||  O  || The minimum zoom level ''(since !RemoteControl Version 1.4)'' ||
+|| `max_zoom` ||  O  || The maximum zoom level. For higher scales, the images of the maximum level is enlarged ''(since !RemoteControl Version 1.4)'' ||
+|| `name` ||  O  || alias for `title` ''(since !RemoteControl Version 1.10)'' ||
+|| `attribution-text` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `attribution-url` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `bestMarked` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `bounds` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `category` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `country-code` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `customHttpHeaders` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `date` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `default-layers` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `description` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `eula` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `icon` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `id` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `logo-image` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `logo-url` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `metadataHeaders` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `minimumTileExpire` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `modTileFeatures` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `noTileChecksums` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `noTileHeaders` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `overlay` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `permission-reference-url` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `pixel-per-eastnorth` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `projections` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `shapes` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `terms-of-use-text` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `terms-of-use-url` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `tileSize` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `transparent` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `type` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
+|| `valid-georeference` ||  O  || ''(since !RemoteControl Version 1.10)'' ||
 ==== Examples ====
+* TMS layer "osm" {{{http://tile.openstreetmap.org/{zoom}/{x}/{y}.png}}}
 [http://localhost:8111/imagery?title=osm&type=tms&url=http://tile.openstreetmap.org/%7Bzoom%7D/%7Bx%7D/%7By%7D.png]
+* TMS layer "osm" {{{https://tile.openstreetmap.org/{zoom}/{x}/{y}.png}}}
+http://localhost:8111/imagery?title=osm&type=tms&min_zoom=1&max_zoom=20&url=https://tile.openstreetmap.org/%7Bzoom%7D/%7Bx%7D/%7By%7D.png
 * WMS layer "landsat" {{{http://irs.gis-lab.info/?layers=landsat&SRS={proj}&WIDTH={width}&HEIGHT={height}&BBOX={bbox} }}}
+[http://localhost:8111/imagery?title=landsat&type=wms&url=http://irs.gis-lab.info/?layers=landsat&SRS=%7Bproj%7D&WIDTH=%7Bwidth%7D&HEIGHT=%7Bheight%7D&BBOX=%7Bbbox%7D]
+http://localhost:8111/imagery?title=landsat&type=wms&url=http://irs.gis-lab.info/?layers=landsat&SRS=%7Bproj%7D&WIDTH=%7Bwidth%7D&HEIGHT=%7Bheight%7D&BBOX=%7Bbbox%7D
+* "Bing" layer
+http://localhost:8111/imagery?id=Bing
 === {{{load_object}}} ===
 Instructs JOSM to download objects with a given id.
 {{{
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
+|| `objects` || R || Comma separated list of object ids, e.g. "{{{n1234,n1235,w84,r958493}}}" ||
+|| `new_layer` || O || If '''true''', downloads to a new layer ||
+|| `addtags` || O || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+|| `relation_members` || O || If '''true''', downloads objects members of the relations as well. ||
+|| `referrers` || O || If '''true''', downloads referrers of the object as well. I.e. parent relations, and for nodes, additionally, parent ways. (since r6782) ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `objects` ||  R  || Comma separated list of object ids, e.g. "{{{n1234,n1235,w84,r958493}}}" ||
+|| `new_layer` ||  O  || If '''true''', downloads to a new layer. (Overwrites user preference, see #19308) ||
+|| `addtags` ||  O  || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+|| `relation_members` ||  O  || If '''true''', downloads objects members of the relations as well. ||
+|| `referrers` ||  O  || If '''true''', downloads referrers of the object as well. I.e. parent relations, and for nodes, additionally, parent ways. ''(since r6782)'' ||
+|| `layer_name` ||  O  || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+|| `layer_locked` ||  O  || Only valid when the data is loaded in a new layer; If '''true''', new layer is [wikitr:/Help/Action/LockedLayer locked] ||
+|| `download_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' , download is [wikitr:/Help/Action/BlockDownload blocked] ||
+|| `upload_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [wikitr:/Help/Action/EncourageDiscourageUpload blocked or discouraged] ||
 ==== Example ====
 [http://localhost:8111/load_object?new_layer=true&objects=w106159509]
 === {{{add_node}}} ===
 Instructs JOSM to create a new node at the given coordinates.
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
 || `lon` || R || The longitude of the node ||
 || `lat` || R || The latitude of the node ||
 || `addtags` since v1.5|| O || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `lon` ||  R  || The longitude of the node ||
+|| `lat` ||  R  || The latitude of the node ||
+|| `addtags` ||  O  || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ''(since v1.5)'' ||
 ==== Example ====
 http://localhost:8111/add_node?lon=13.3&lat=53.2
 === {{{add_way}}} ===
 Instructs JOSM to create a new way with new way nodes at given coordinates.
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
 || `way` || R || Pairs of latitude, longitude coordinates separated by semicolon. ||
 || `addtags` since v1.5|| O || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `way` ||  R  || Pairs of latitude, longitude coordinates separated by semicolon. ||
+|| `addtags` ||  O  || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ''(since v1.5)'' ||
 ==== Example ====
 http://localhost:8111/add_way?way=53.2,13.3;53.3,13.3;53.3,13.2
 …
 === {{{version}}} ===
 This command returns the current protocol version of the installed !RemoteControl interface. Developers can use it to query for a running instance of JOSM and also determine whether the requested functionality is available in the client.
 {{{
 GET /version[?jsonp=callback]
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
 || `jsonp` || O|| Jsonp callback for older browsers not implementing Cross-Origin Resource Sharing (CORS) ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `jsonp` ||  O  || Jsonp callback for older browsers not implementing Cross-Origin Resource Sharing (CORS) ||
 The command returns a json object containing an application identifier that is always "JOSM !RemoteControl", a major number and a minor number. Compatible protocol changes result in an increase of the minor number. Incompatible changes increase the major number. So a client application knowing of protocol version 1.0 can still talk to JOSM having 1.1. But it's not guaranteed to be working with 2.0. So the client should verify the major number.
 …
       "minor": 0
    },
+   "application": "JOSM RemoteControl"
+   "application": "JOSM RemoteControl",
+   "version": 16587 // JOSM version (since r16587)
+}
 }}}
 …
 }}}
+=== {{{openapi.json}}} ===
+JOSM RemoteControl as [https://swagger.io/specification/ OpenAPI Specification]
+* http://localhost:8111/openapi.json
+* https://petstore.swagger.io/?url=http://localhost:8111/openapi.json
 === Adding, changing or deleting tags === #addtags
 …
 The user must review the tags and the selection before the tags are applied to the selected objects.
 If the tag exists on some objects, it will be can be replaced.
+If the tag exists on some objects, it will be replaced.
 Since protocol version 1.5
 …
 Remotecontrol allows other plugins to add additional commands. The other registers a RequestHandler class and specifies a command to be handled by this class. The command syntax has to be defined by the other plugin.
+Reverter plugin since version 27091 makes use of this feature.
+==== Reverter ====
+Reverter plugin since version 27091 makes use of this feature. See [source:osm/applications/editors/josm/plugins/reverter/src/reverter/RevertChangesetHandler.java RevertChangesetHandler.java].
+==== Mapillary ====
+See [https://github.com/JOSM/Mapillary/blob/master/src/main/java/org/openstreetmap/josm/plugins/mapillary/io/remotecontrol/MapillaryRemoteControl.java MapillaryRemoteControl.java].
+Either `sequence` or `photo` must be specified, but not both. Since the remote control class was written for multiple imagery sources, the id for either `sequence` or `photo` ''must'' be prefixed with `Mapillary/`.
+==== Compilation of plugin remote control commands ====
+||= Plugin =||= **Command** =||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| Reverter || `revert_changeset` ||  ||  || Base command to revert a changeset ||
+|| || || `id` ||  R  || The changeset id to use (should match regex `[0-9]+`) ||
+|| MapWithAI || `mapwithai` || || || Base command to download MapWithAI data ||
+|| || || `max_obj` ||  O  || Set the maximum number of objects the user can add per action from the MapWithAI layer. Should match regex `[0-9]+`. ||
+|| || || `switch_layer` ||  O  || Use if you want to force users to automatically switch layers when they add data to OSM. Takes `true`/`false`. ||
+|| || || `bbox` ||  O  || The bbox to download (`lat,lon,lat,lon` -- assumes the bbox will not cross meridian) ||
+|| || || `crop_bbox` ||  O  || Crop downloaded MapWithAI data (roads only) to this bbox. Tasking managers may also generate a well-known layer. ||
+|| || || `url` ||  O  || The URL to use instead of the built-in data sources. Useful for imports (please make certain you went through the import process). ||
+|| || || `source` ||  O  || The source to use when uploading to OSM (changeset source) ||
+|| Mapillary || `photo` || || || Base command to download a Mapillary photo (may be extended to other imagery sources in the future) ||
+|| || || `photo` ||  R/O  || The id of the image to show and download. Either this or `sequence` must be specified. ||
+|| || || `sequence` ||  R/O  || The id of the sequence to show and download. First image is shown in image viewer. ||
 ----
+Back to [[Help/Preferences/RemoteControl]][[br]]
+Back to [[Help/Preferences]][[br]]
+Back to [[Help]]
+Back to [wikitr:/Help/Preferences/RemoteControl Remote control preferences] \\
+Back to [wikitr:/Help/Preferences Preferences] \\
+Back to [wikitr:/Help Main Help]