- URL:
- https://<root>/services/<ServiceName>.<ServiceType>/changeProvider
- Methods:
POST- Version Introduced:
- 10.9
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 change operation updates an individual service to use either a dedicated or a shared instance type. When a qualified service is published, the service is automatically set to use shared instances.
When using this operation, services may populate other provider types as values for the provider parameter, such as Arc and SDS. While these are valid provider types, this operation does not support changing the provider of such services to either Arc or D. Services with Arc or SDS as their provider cannot change their instance type.
Request parameters
| Parameter | Details |
|---|---|
| Specifies the service instance as either a shared ( Values: |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the change operation:
POST /<context>/admin/services/Hosted/TestMap.MapServer/changeProvider HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
provider=DMaps&f=pjson&token=IxAYQhLzYLltj1uu7l4eQ0bNjxb2O8uFD2EVSj35okQ-8SNpbJpZ3B6nfG8SU9FskJLWQNLkRrP6xJTZDoDz0n1MhLm7SCNo8VZWZR4RwBWmpQReLg9uMNv8gJB5cazHceuBjXu9kBbUnn6Laq36Z4TTQgfiPd3N2adEGcHKSDX9EwzSqyMg_YA1hjDhDJRn33o3VYiGMriW9i6duYcngjYdwTrVQLh2pOU6NgMmIj84CXeXrvlS0VmIK7e4KvxYJSON Response examples
The following response indicates that the change operation was executed successfully:
{"status": "success"}The following error response occurs when a provider value that is incompatible with the service is set.
{
"status": "error",
"messages": ["Changing the provider of the service 'TestMap.MapServer' to 'DMaps' is not permitted. "],
"code": 500
}