Skip To Content
ArcGIS Developers
Dashboard

Register Extension

Description

Caution:

At 10.91, when installing ArcGIS Server you will have the option to disable the ArcMap service runtime, removing Python 2.x from your deployment. If the ArcMap runtime is disabled, you will be unable to upload ArcMap-based SOEs. Attempting to register these items will result in an error message. For more information, see the JSON Response examples section below.

This operation registers a new server object extension (SOE) file with the server. Before you register the file, you need to upload the SOE file to the server using the Upload Data Item operation. The itemID returned by the upload operation must be passed to the register operation. This operation registers all the server object extensions defined in the SOE file.

Note:
While registering a new SOE file, you need to make sure that none of the extensions within the SOE file have been previously registered. To change existing extensions, use the Update Extension operation.

Request parameters

ParameterDetails
id

The uploaded item ID of the SOE file.

Example

id=i03a2b59db-e60d-48ce-8b0e-2fd3cff73b1a
f

The response format. The default response format is html.

Values: html | json| pjson

Example usage

Below is a sample POST request for register:

POST /webadaptor/admin/services/types/extensions/register HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

id=i03a2b59db-e60d-48ce-8b0e-2fd3cff73b1a&f=json

JSON Response examples

The following is a sample success response for the register operation, indicating that the SOE file was uploaded successfully:

{
  "status": "success"
}

The following error response is returned when an attempt is made to upload an ArcMap-based SOE file when the ArcMap runtime is disabled:

{
  "status": "error",
  "messages": ["This ArcMap based extension cannot be deployed because the ArcMap Runtime Support feature is not installed. Information on how to migrate extensions to use the ArcGIS Pro service runtime is available in the help topic 'Migrating services to the ArcGIS Pro service runtime'."],
  "code": 500
}