- URL:
- https://<root>/system/enterprisefunctions/remove
- Methods:
POST- Version Introduced:
- 11.2
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The remove operation disables a premium capability for an organization, such as raster analytics or image hosting.
This operation is performed asynchronously and will return a job URL that can be used to check the status of the request. When the request is submitted, ArcGIS Enterprise on Kubernetes checks to see if any other premium capabilities that share the same System and Utility services are currently enabled.
If another premium capability is still enabled, and both it and the capability being disabled share the same System and Utility services, those services are not stopped. For example, if Image is being disabled, but Raster is still enabled, the System and Utility services used by both Image and Raster are not disabled.
If no other premium capability is enabled, the System and Utility services are stopped.
Request parameters
| Parameter | Details |
|---|---|
| Specifies the premium capability that is being disabled. Only one premium capability can be disabled per request. Values: |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the remove operation:
POST /<context>/admin/system/enterprisefunctions/remove HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
enterpriseFunction=RasterAnalytics&f=pjson&token= MxOTGPw1srr5-B3I3xMdmzsjKFZ5XcX_ooLc2ijMfCZCMwYR2z2wa0NQXwm2crl9g419kgFdkU9Bhg56vQICl28agx-gAwPu9PfQ2SHS71i50RFsy8YIRw2D-BXNgp94XkIWsl3VplgL5VCoZI07cG8igG5cmX_rInNgDa79Vi5NHRy96elM_6SUbTmbQ9ioG7xbNoVMwpW7nBlP3H4YBke67mjFF6onGZ9FTAcz_8qjHuSPxQwZu6DEnLbkrfT1JSON Response example
The following response is returned each time a request is submitted:
{
"jobsUrl": "https://organization.example.com/<context>/admin/jobs/jcdbf4e88-c4ca-42bc-a40f-036c40bbce15",
"jobid": "jcdbf4e88-c4ca-42bc-a40f-036c40bbce15",
"status": "SUBMITTED"
}Once submitted, users can access the job using the jobs returned above to periodically poll the its status.
The following response is returned if the job is completed successfully without encountering any errors:
{
"updatedtime": 1699514547531,
"jobid": "jf846e55c-84dd-431f-895c-1b2573d2baf9",
"requestID": "f9dc2911-5ee6-40b5-8bb4-b6074640def6",
"name": "removeEnterpriseFunction",
"endtime": 1699514547532,
"messages": [
"Removing 'RasterAnalytics' enterprise function",
"Stopping RasterAnalytics Services",
"Unregistering the following services as Portal helper services - RasterAnalysisTools, RasterUtilities"
],
"starttime": 1699514538638,
"operationURI": "removeEnterpriseFunction",
"status": "COMPLETED",
"username": "administrator"
}