Java simple REST SOE with properties

This sample illustrates how to develop a REST server object extension (SOE) with properties and a custom property page for ArcGIS Server Manager. These properties appear in ArcGIS Server Manager and can be changed by the server administrator.


Deploying the SOE from the .soe file (../simplerestsoewithproperties/target/simplerestsoewithproperties.soe) does not require you to open a Java IDE. However, you can open the project (../simplerestsoewithproperties) in a Java IDE, such as Eclipse or IntelliJ, to debug, modify, and recompile the SOE code.


  • SOE properties
  • Custom property page

Sample data

Any dynamic map service published from ArcGIS Pro. This instruction uses the USA map service as the sample service to test with the SOE.


Deploy the SOE

  1. Log in to ArcGIS Server Manager and click the Site tab.
  2. Click Extensions.
  3. Click Add Extension.
  4. Click Choose File and choose the simplerestsoewithproperties.soe file (../target/simplerestsoewithproperties.soe).
  5. Click Add.

Enable the SOE on a map service

  1. Make sure you have published the USA map service using ArcGIS Pro. If not, refer to USA map service

  2. Log in to ArcGIS Server Manager and click the Services tab. Select USA map service and select Capabilities.

  3. In the list of available capabilities, find Java Simple REST SOE with Properties and check the box to enable it.

  4. Make sure the SOE is selected. Notice four properties appear in the Properties section.


  5. Click the Save and Restart button to restart the service.

Test the SOE in the ArcGIS Server Services Directory

  1. Open a browser and navigate to the REST services endpoint of the USA map service (URL: http://<serverdomain>/<webadaptorname>/rest/services/USA/MapServer).

  2. Scroll to the bottom of the above page. Click JavaSimpleRESTSOEWithProperties in Supported Extensions.

    This leads to the following URL:


    This SOE root resource page displays the SOE's name, description, and its child resources.

  3. Click the properties sub-resource and it returns the name and value of the four properties.


  4. Navigate back to the service's Capabilities page in ArcGIS Server Manager again.

    Modify the values of the properties and click the Save and Restart button to restart the service.

    Repeat step 3 and you will notice the updated property values are returned.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.