ArcGIS Enterprise SDK

ArcGIS Enterprise Software Development Kit (SDK) allows developers to extend ArcGIS Enterprise functionalities. It supports extending the functionality of the map services and image services published from ArcGIS Pro. There are two ways to extend these services:

  • Server object extensions (SOEs) allow you to create new service operations to extend the base service functionality. SOEs are appropriate if you want to perform some well-defined business logic to work with the GIS data and services that is not easily accomplished using the existing service APIs.

  • Server object interceptors (SOIs) is capable of intercepting requests for built-in operations of map services and image services. This allows you to execute custom logic and alter the behavior of these services by overriding existing operations in a way that is seamless to existing clients, such as ArcGIS Pro, Map Viewer, and more.

SOEs and SOIs can be developed with .NET or Java.

Get started with SOE and SOI

Prerequisites

The ArcGIS Enterprise SDK is included with your license for the ArcGIS Enterprise product. There is no separate purchase or authorization mechanism specifically for the ArcGIS Enterprise SDK. However, as SOEs and SOIs must be deployed via ArcGIS Server, you must have a licensed ArcGIS Server to deploy or test the SOE/SOI.

Before you install the SDK, check System Requirements to make sure you have installed the following software or components of supported versions:

  • Developing a .NET SOE or SOI:
    • Visual Studio
    • .NET Framework
  • Developing a Java SOE or SOI:
    • Java IDE
    • JDK
    • Maven (required since the 10.8.1 release)

Install ArcGIS Enterprise SDK

To download ArcGIS Enterprise SDK, there are two ways:

  • Download at My Esri.

    1. Log in to https://my.esri.com website.
    2. Find ArcGIS Enterprise under Downloads tab.
    3. Click the View Downloads button.
    4. Find ArcGIS Enterprise SDK under Developer Tools section and click Download.
  • Download at ArcGIS for Developers.

    1. Sign up for ArcGIS for Developers for free.
    2. Click the Download APIs & SDKs button.
    3. Find ArcGIS Enterprise SDK and click the Download button.

Then, you can install ArcGIS Enterprise SDK on your development environment. See SDK installation guide for .NET and Java.

Build a simple SOE or SOI

The following are simple SOEs and SOIs that you can start with:

Video

Blog

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