- URL:
- https://<root>/system/enterprisefunctions/add
- 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 add operation enables premium capabilities for an organization, such as raster analytics or image hosting. The organization must have the appropriate licensing for these capabilities before performing this operation. For some premium capabilities, administrators may need to register an additional, specific type of data store.
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 the requirements for the specified capability has been met. If requirements have been met, the system will start the required System and Utility services and will add any required Utility services that are used as helper services. If the requirements are not met, the job will fail. If the job fails, the add operation can be performed again and the new job will resume from where the previous job left off.
If the requirements are not met, the Job resource will return a FAILED status and detailed messaging regarding the reason for failure. Otherwise, the job will return a SUCCESS response and the organization will be able to se the premium capabilities.
Request parameters
| Parameter | Details |
|---|---|
| Specifies the premium capability that is being enabled. Only one premium capability can be enabled per request. Values: |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the add operation:
POST /<context>/admin/system/enterprisefunctions/add HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
enterpriseFunction=ImageHosting&f=pjson&token= MxOTGPw1srr5-B3I3xMdmzsjKFZ5XcX_ooLc2ijMfCZCMwYR2z2wa0NQXwm2crl9g419kgFdkU9Bhg56vQICl28agx-gAwPu9PfQ2SHS71i50RFsy8YIRw2D-BXNgp94XkIWsl3VplgL5VCoZI07cG8igG5cmX_rInNgDa79Vi5NHRy96elM_6SUbTmbQ9ioG7xbNoVMwpW7nBlP3H4YBke67mjFF6onGZ9FTAcz_8qjHuSPxQwZu6DEnLbkrfT1JSON Response examples
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 job's status.
If the job encounters an error, the following response is returned:
{
"updatedtime": 1697690865773,
"jobid": "j7ca2e78c-a8c7-41d0-9df5-25f4635fd1bc",
"requestID": "06c4eb93-807c-4da5-9df9-5f1be1066b16",
"name": "addEnterpriseFunction",
"endtime": 1697690865777,
"messages": [
"Checking if license to enable 'RasterAnalytics' function is available.",
"Checking if a raster data store is present",
"Raster Store not available. Failed to assign RasterAnalysis role.",
"Error assigning 'RasterAnalytics' enterprise function. Check logs for more details."
],
"starttime": 1697690865644,
"operationURI": "addEnterpriseFunction",
"status": "FAILED",
"username": "administrator"
}The following response is returned if the job is completed successfully without encountering any errors:
{
"updatedtime": 1697691723840,
"jobid": "j0bbeed82-47ef-41a7-a92f-3641b95f90a0",
"requestID": "82a42e06-ed74-4dfb-b439-7b1928902a94",
"name": "addEnterpriseFunction",
"endtime": 1697691723847,
"messages": [
"Checking if license to enable 'RasterAnalytics' function is available.",
"Checking if a raster data store is present",
"Checking if RasterAnalytics Services need to be started",
"Starting System.RasterRendering.ImageServer",
"Starting System.RasterAnalysisTools.GPServer",
"Starting System.RasterProcessing.DPServer",
"Starting Utilities.RasterUtilities.GPServer",
"Starting System.RasterProcessingGPU.DPServer",
"System/RasterRendering.ImageServer started succesfully",
"System/RasterAnalysisTools.GPServer started succesfully",
"System/RasterProcessing.DPServer started succesfully",
"Utilities/RasterUtilities.GPServer started succesfully",
"System/RasterProcessingGPU.DPServer started succesfully",
"Updating the following services as Portal helper services - RasterAnalysisTools, RasterUtilities",
"Sharing RasterUtilities service with org",
"Adding 'RasterAnalytics' enterprise function"
],
"starttime": 1697691137001,
"operationURI": "addEnterpriseFunction",
"status": "COMPLETED",
"username": "administrator"
}