Replace Service

  • URL:http://<content-url>/users/<username>/replaceService(POST only)
  • Version Introduced:10.6

Description

The replaceService operation allows you to replace vector tile layers. The replaceService operation on vector tile layers allows you to perform quality control on a staging tile layer and to then replace the production tile layer with minimal downtime. This operation has the option to keep a backup of the production tile layer.

Workflow for replaceService:

  1. The staging service is published to the same system as the production service. Both services are active at the same time. The staging service is shared with a smaller set of users. Staging service is QA'd and made ready for production.
  2. The item properties (ex: thumbnail, iteminfo, metadata) of the production item will not be replaced or updated. Please use the portal to update item properties.
  3. When the replaceService operation is used, the service running on the hosting server will be replaced (for example, its cache).
  4. It is the responsibility of the user to ensure that the replacement layer uses similar content and cartography to the replaced layer. This will ensure that dependent layers with modified styles continue to work.
  5. If you want to retain the replaced production service, for example, to keep an archive of the evolution of the service you can do so by omitting a value for "Replaced Service Name" . If replaced service name is not provided, the production service being replaced will be archived with a time stamp when replace service was executed on it. You can provide any name for the replaced service as long as it is not pre-existing on your portal content.

Request Parameters

ParameterDetails
toReplaceItemId

The item ID of the service to be replaced.

replacementItemId

The item ID of the replacement service.

replacedServiceName

The name of the replacement service.

replaceMetadata

When set to true, the item info {"thumbnail", "tag", "description", "summary"} of the current service is updated to that of the replacement service. The Credits, Terms of use, and Created from details will not be replaced. This option is set to false by default.

f

An optional output format parameter.

Values: html | json

JSON Response Syntax

{
  "success": true | false

}

JSON Response Example

{
  "success": true,
}