CloudStreams 10.5 | webMethods CloudStreams | Administering webMethods CloudStreams | Admin Folder | pub.cloudstreams.admin.service:update
 
pub.cloudstreams.admin.service:update
This service allows you to update a CloudStreams connector service node from one version of connector API to a higher version for various attributes such as the Connection Alias and the Virtual Service Name. If the connector service node was created with an earlier version of CloudStreams, you must first migrate the service node before using the update service. For information on how to migrate a connector service node, see the Upgrading Software AG Products document.
Note: 
*Make a backup copy of the existing package containing the CloudStreams connector service node before running the update service.
*If the update service is used to update a CloudStreams connector service node to a higher version of API and if backward compatibility is not supported by the SaaS provider, the CloudStreams connector service node may not function properly.
*It is recommended to use the update service to update a CloudStreams connector service node from a lower version of connector API to a higher version. Using the update service to update a CloudStreams connector service node from a higher version of API to a lower version is not supported.
*Updating a non-CUSTOM CloudStreams connector service node to CUSTOM type, that is, having an operation with either input.body.transformer or output.body.transformer property is also not supported.
By default, the update service runs under simulation mode, that is, no actual changes are made to the corresponding CloudStreams connector service node and only a check is performed if the service node can be updated successfully.
Input Parameters
cloudServiceName
String. Required. Name of the CloudStreams connector service node which needs to be updated.
connectionAlias
String. Optional. Name of the new connection alias. The CloudStreams connector service node will get updated to use this new connections alias. The connector associated with the new connection alias must be from the same provider package and should be of the same type, that is, REST/SOAP.
virtualServiceName
String. Optional. Name of the new virtual service name. The CloudStreams connector service node will get updated to use this new virtual service. For more information on virtual services, see Virtual Services.
simulate
String. Optional. Allowed values are true or false. Instructs the update service to run in simulation mode during which no changes are made to a CloudStreams connector service node, and only a check is performed if a service node can be updated successfully or not. Default value is true. Set simulate to false to persist the changes made to a CloudStreams connector service node.
force
String. Optional. Allowed values are true or false. Instructs the update service to continue updating a CloudStreams connector service node, and ignore errors it encounters related to missing headers, parameters, and custom input/output document types that can prevent the service node from being updated in a normal scenario. Default value is false. Using force as true may result in an unusable CloudStreams connector service node with incorrect mappings and subsequent service execution failure.
Output parameters
success
Boolean String. Required.
*true − If the CloudStreams connector service node was updated successfully.
*false − If the CloudStreams connector service node update has failed.
errorMessage
String. Optional. Information on the cause of the error, if the update has failed.