Register Extension

URL:
https://<root>/services/types/extensions/register
Methods:
POST
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.1

Description

The register operation registers the SOEs defined in the .soe file. A .soe file is a container of one or more server object extensions.

Before you perform this operation, the .soe file needs to be uploaded it to the server. The itemID returned after uploading the file is used as the value for the id parameter.

Starting with ArcGIS Enterprise 11.0, ArcObjects extensions and 10.x versions of Enterprise SDK extensions are no longer supported. Attempting to register or enable these extensions will fail with an error message. Only version 11.x extensions can be registered.

Request parameters

ParameterDetails

id

The uploaded item ID of the .soe file.

Example
Use dark colors for code blocksCopy
1
id=i03a2b59db-e60d-48ce-8b0e-2fd3cff73b1a

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the register operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
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 example

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

Use dark colors for code blocksCopy
1
2
3
{
  "status": "success"
}

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