MidVision RapidDeploy technical documentation site

Copy Project Web Service

This web service copies a RapidDeploy project on the framework server.

Example request

PUT http://localhost:9090/MidVision/ws/project/ACE_Test/copy HTTP/1.1
Accept-Encoding: gzip, deflate, br
Authorization: ********************
Content-Type: application/xml
Content-Length: 10982
Host: localhost: 8090
Connection: Keep-Alive
User-Agent: PostmanRuntime/7.26.8

<Project>
    <description>A project to deploy ACE configuration.</description>
    <enabled>true</enabled>
    <logDirectory>/Users/rafaelruizpalacios/mv_home_trunk/logs</logDirectory>
    <name>ACE_Deploy</name>
    <orchestrationFileName>midvision-deploy-orchestration.xml</orchestrationFileName>
    <owner>
        <description>This is the default MidVision Administrator</description>
        <email>mvadmin@midvision.com</email>
        <enabled>true</enabled>
        <firstname>MidVision</firstname>
        <lastname>Administrator</lastname>
        <optlock>201</optlock>
        <sourceType>0</sourceType>
        <username>mvadmin</username>
    </owner>
    <pluginDataSet>
        <pluginData>&lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;projectPlugins&gt;&lt;projectPlugins&gt;&lt;active&gt;true&lt;/active&gt;&lt;classname&gt;com.midvision.rapiddeploy.plugins.scm.filesystem.FileSystem&lt;/classname&gt;&lt;data&gt;&lt;name&gt;FileSystem&lt;/name&gt;&lt;displayName&gt;File System&lt;/displayName&gt;&lt;version&gt;5.1.0&lt;/version&gt;&lt;description/&gt;&lt;fields&gt;&lt;headerTitle&gt;File System Scm Repository&lt;/headerTitle&gt;&lt;headerLayout&gt;TABLE&lt;/headerLayout&gt;&lt;fieldKey&gt;rootDirectory&lt;/fieldKey&gt;&lt;fieldValue&gt;/Users/rafaelruizpalacios/mv_home_trunk/projects/ACE_Deploy&lt;/fieldValue&gt;&lt;label&gt;Project root directory&lt;/label&gt;&lt;type&gt;DIRECTORY&lt;/type&gt;&lt;mandatory&gt;true&lt;/mandatory&gt;&lt;helpText&gt;The location on the RapidDeploy server where project artifacts will be written to. All configuration files, 
                deployable components (such as ear files), templates etc will be stored under this root directory.
                Sub-directories will be determined by the collection type chosen for this project.&lt;/helpText&gt;&lt;toolTipText&gt;The location on the RapidDeploy server where project artifacts will be written to.
                &lt;/toolTipText&gt;&lt;style&gt;width: 50em;&lt;/style&gt;&lt;classType&gt;java.lang.String&lt;/classType&gt;&lt;/fields&gt;&lt;fields&gt;&lt;headerTitle&gt;File System Scm Repository&lt;/headerTitle&gt;&lt;headerLayout&gt;TABLE&lt;/headerLayout&gt;&lt;fieldKey&gt;deleteProjectFiles&lt;/fieldKey&gt;&lt;fieldValue&gt;true&lt;/fieldValue&gt;&lt;label&gt;Delete Project Files&lt;/label&gt;&lt;listOfChoices&gt;true,false&lt;/listOfChoices&gt;&lt;type&gt;CHECKONE&lt;/type&gt;&lt;mandatory&gt;false&lt;/mandatory&gt;&lt;helpText&gt;Project Files removal after project deletion.&amp;lt;br/&amp;gt;
                Generally, leave this as the default (false).&amp;lt;/br&amp;gt;
                When this is set in false, after project deletion, the files keep in the FS.&amp;lt;/br&amp;gt;
                Otherwise the project files are removed from the FS.
                &lt;/helpText&gt;&lt;toolTipText&gt;Enable/Disable Project Files removal after project deletion.&lt;/toolTipText&gt;&lt;style/&gt;&lt;classType&gt;java.lang.Boolean&lt;/classType&gt;&lt;/fields&gt;&lt;panelTitle&gt;File System Scm Repository&lt;/panelTitle&gt;&lt;/data&gt;&lt;pluginName&gt;FileSystem (No SCM) (v5.1.0)&lt;/pluginName&gt;&lt;pluginType&gt;scm&lt;/pluginType&gt;&lt;pluginVersion&gt;5.1.0&lt;/pluginVersion&gt;&lt;/projectPlugins&gt;&lt;projectPlugins&gt;&lt;active&gt;true&lt;/active&gt;&lt;classname&gt;com.midvision.rapiddeploy.plugins.artifact.localfile.LocalFile&lt;/classname&gt;&lt;data&gt;&lt;name&gt;LocalFile&lt;/name&gt;&lt;displayName&gt;Local File&lt;/displayName&gt;&lt;version&gt;5.1.3&lt;/version&gt;&lt;description&gt;This is a file based aritfact respository&amp;lt;br/&amp;gt;
                        Please specify where the deployment artifacts are located in the build and promotion stores and the search string to use to locate the artifacts.&amp;lt;br/&amp;gt;&lt;/description&gt;&lt;fields&gt;&lt;headerTitle&gt;File Based Repository&lt;/headerTitle&gt;&lt;headerLayout&gt;TABLE&lt;/headerLayout&gt;&lt;fieldKey&gt;buildStore&lt;/fieldKey&gt;&lt;fieldValue&gt;/Users/rafaelruizpalacios/mv_home_trunk/buildstore&lt;/fieldValue&gt;&lt;label&gt;Build Store&lt;/label&gt;&lt;type&gt;DIRECTORY&lt;/type&gt;&lt;mandatory&gt;true&lt;/mandatory&gt;&lt;helpText&gt;The location on the RapidDeploy server where project deployment packages will be written to. This location may be shared with other projects.&lt;/helpText&gt;&lt;toolTipText&gt;The location on the RapidDeploy server where project deployment packages will be written to. This location may be shared with other projects.&lt;/toolTipText&gt;&lt;style&gt;width: 50em;&lt;/style&gt;&lt;classType&gt;java.lang.String&lt;/classType&gt;&lt;/fields&gt;&lt;fields&gt;&lt;headerTitle&gt;File Based Repository&lt;/headerTitle&gt;&lt;headerLayout&gt;TABLE&lt;/headerLayout&gt;&lt;fieldKey&gt;promotionStore&lt;/fieldKey&gt;&lt;fieldValue&gt;/Users/rafaelruizpalacios/mv_home_trunk/promotionstore&lt;/fieldValue&gt;&lt;label&gt;Promotion Store&lt;/label&gt;&lt;type&gt;DIRECTORY&lt;/type&gt;&lt;mandatory&gt;true&lt;/mandatory&gt;&lt;helpText&gt;The location on the RapidDeploy server where project deployment packages will be written to via promotion for deployment to controlled environments. This location may be shared with other projects.&lt;/helpText&gt;&lt;toolTipText&gt;The location on the RapidDeploy server where project deployment packages will be written to via promotion for deployment to controlled environments. This location may be shared with other projects.&lt;/toolTipText&gt;&lt;style&gt;width: 50em;&lt;/style&gt;&lt;classType&gt;java.lang.String&lt;/classType&gt;&lt;/fields&gt;&lt;fields&gt;&lt;headerTitle&gt;File Based Repository&lt;/headerTitle&gt;&lt;headerLayout&gt;TABLE&lt;/headerLayout&gt;&lt;fieldKey&gt;deploymentPackageSearchString&lt;/fieldKey&gt;&lt;fieldValue&gt;ACE_Deploy&lt;/fieldValue&gt;&lt;label&gt;Deployment Package Search String&lt;/label&gt;&lt;type&gt;TEXT&lt;/type&gt;&lt;mandatory&gt;true&lt;/mandatory&gt;&lt;helpText&gt;The string selector present in each deployment package name to identify packages belonging to this project.
                This is basically a substring of the deployment package name to search for in the "Build Store" or "Promotion Store".&amp;lt;br/&amp;gt;&amp;lt;br/&amp;gt;
                If the "Regular Expression" field is enabled then this field can contain a regular expression to search for deployment packages in the "Build Store" or "Promotion Store".&lt;/helpText&gt;&lt;toolTipText&gt;The string selector present in each deployment package to identify packages belonging to this project.&lt;/toolTipText&gt;&lt;style&gt;width: 50em;&lt;/style&gt;&lt;classType&gt;java.lang.String&lt;/classType&gt;&lt;/fields&gt;&lt;fields&gt;&lt;headerTitle&gt;File Based Repository&lt;/headerTitle&gt;&lt;headerLayout&gt;TABLE&lt;/headerLayout&gt;&lt;fieldKey&gt;regularExpression&lt;/fieldKey&gt;&lt;fieldValue&gt;false&lt;/fieldValue&gt;&lt;label&gt;Regular Expression&lt;/label&gt;&lt;listOfChoices&gt;true,false&lt;/listOfChoices&gt;&lt;type&gt;CHECKONE&lt;/type&gt;&lt;mandatory&gt;false&lt;/mandatory&gt;&lt;helpText&gt;Set this option to TRUE if deployment package search string is based on regular expression format.&lt;/helpText&gt;&lt;toolTipText&gt;Set this option to TRUE if deployment package search string is based on regular expression format.&lt;/toolTipText&gt;&lt;style/&gt;&lt;classType&gt;java.lang.Boolean&lt;/classType&gt;&lt;/fields&gt;&lt;fields&gt;&lt;headerTitle&gt;File Based Repository&lt;/headerTitle&gt;&lt;headerLayout&gt;TABLE&lt;/headerLayout&gt;&lt;fieldKey&gt;supportLargeFiles&lt;/fieldKey&gt;&lt;fieldValue&gt;false&lt;/fieldValue&gt;&lt;label&gt;Support Large Files&lt;/label&gt;&lt;listOfChoices&gt;true,false&lt;/listOfChoices&gt;&lt;type&gt;CHECKONE&lt;/type&gt;&lt;mandatory&gt;false&lt;/mandatory&gt;&lt;helpText&gt;Set this option to TRUE if you expect to have packages greater than 4Gb. Notice that setting this option might make the file incompatible with other ZIP utilities and you NEED to set useAntCompression in the Initialisation Task.&lt;/helpText&gt;&lt;toolTipText&gt;Set this option to TRUE if you expect to have packages greater than 4Gb. Notice that setting this option might make the file incompatible with other ZIP utilities and you NEED to set useAntCompression in the Initialisation Task.&lt;/toolTipText&gt;&lt;style/&gt;&lt;classType&gt;java.lang.Boolean&lt;/classType&gt;&lt;/fields&gt;&lt;fields&gt;&lt;headerTitle&gt;File Based Repository&lt;/headerTitle&gt;&lt;headerLayout&gt;TABLE&lt;/headerLayout&gt;&lt;fieldKey&gt;deleteProjectPackages&lt;/fieldKey&gt;&lt;fieldValue&gt;false&lt;/fieldValue&gt;&lt;label&gt;Delete Project Packages&lt;/label&gt;&lt;listOfChoices&gt;true,false&lt;/listOfChoices&gt;&lt;type&gt;CHECKONE&lt;/type&gt;&lt;mandatory&gt;false&lt;/mandatory&gt;&lt;helpText&gt;Deployment packages removal after project deletion.&amp;lt;br/&amp;gt;&amp;lt;br/&amp;gt;
                You should generally leave this disabled by default. When disabled, after
                project deletion the packages are kept in the file system, otherwise the
                deployment packages are removed from the file system.
                &lt;/helpText&gt;&lt;toolTipText&gt;Enable/Disable deployment packages removal after project deletion.&lt;/toolTipText&gt;&lt;style/&gt;&lt;classType&gt;java.lang.Boolean&lt;/classType&gt;&lt;/fields&gt;&lt;panelTitle&gt;File Based Repository&lt;/panelTitle&gt;&lt;/data&gt;&lt;pluginName&gt;Local FileSystem (v5.1.3)&lt;/pluginName&gt;&lt;pluginType&gt;artifact&lt;/pluginType&gt;&lt;pluginVersion&gt;5.1.3&lt;/pluginVersion&gt;&lt;/projectPlugins&gt;&lt;/projectPlugins&gt;</pluginData>
    </pluginDataSet>
</Project>

Example Response

<html>

<head>
   <title>copyProject</title>
   <link href="http://localhost:9090/MidVision/ui/javax.faces.resource/components.css?ln=primefaces" rel="stylesheet" type="text/css" />
</head>

<body>
   <div style="border-bottom: 0.1em solid black; display: block; height: 30px; margin-bottom: 1em; margin-top: 0.5em; position: relative; width: 100%;">
      <h2>copyProject</h2>
   </div>
   <div class="ui-messages ui-widget" aria-live="polite">
      <div class="ui-messages-info ui-corner-all">
         <ul>
            <li><span class="ui-messages-info-summary">Save Orchestration File</span><br/><span class="ui-messages-info-detail">Successfully saved orchestration file: /Users/rafaelruizpalacios/mv_home_trunk/projects/ACE_Deploy/midvision-deploy-orchestration.xml</span></li>
            <li><span class="ui-messages-info-summary">Cleaned packages information.</span><br/><span class="ui-messages-info-detail">Cleaned package information for project [ACE_Deploy].</span></li>
            <li><span class="ui-messages-info-summary">Copy Project</span><br/><span class="ui-messages-info-detail">SUCCESS: The project [ACE_Deploy] has been created.</span></li>
            <li><span class="ui-messages-info-summary">Processed Target: </span><br/><span class="ui-messages-info-detail">ACE_HOST.ace.test</span></li>
            <li><span class="ui-messages-info-summary">Processed Target: </span><br/><span class="ui-messages-info-detail">ACE_HOST_11003.ace.test</span></li>
            <li><span class="ui-messages-info-summary">Processed Target: </span><br/><span class="ui-messages-info-detail">ACE_MQ_HOST.ace.test</span></li>
         </ul>
      </div>
   </div>
</body>

</html>