List Project Details Web Service

This web service list a specific RapidDeploy project on the framework server.

Example request

GET http://localhost:8090/MidVision/ws/project/list HTTP/1.1
Accept-Encoding: gzip,deflate
Authorization: ********************
Host: localhost:8090
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Example Response

<projects>
   <Project xmlns:ns2="http://www.midvision.com/rapiddeploy/domain/xml/resource" xmlns:ns3="http://www.midvision.com/rapiddeploy/domain/xml/resourcelist">
      <createDate>2016-05-13T10:55:13.474-03:00</createDate>
      <description>Run a script on a target server. Change the input environment variables and command line parameters per environment.</description>
      <enabled>true</enabled>
      <logDirectory>C:/midvision_4.0/logs</logDirectory>
      <name>SCRIPT_DEMO_40</name>
      <optlock>4</optlock>
      <orchestrationFileName>midvision-deploy-orchestration.xml</orchestrationFileName>
      <owner>
         <description>This is the default MidVision Administrator</description>
         <email>support@midvision.com</email>
         <enabled>true</enabled>
         <firstname>MidVision</firstname>
         <lastname>Administrator</lastname>
         <optlock>245</optlock>
         <sourceType>1</sourceType>
         <username>mvadmin</username>
      </owner>
      <pluginDataSet>
         <id>177</id>
         <pluginData><![CDATA[<?xml version="1.0" encoding="UTF-8"?><projectPlugins><projectPlugins><active>true</active><data><name>FilesystemFiles</name><displayName>Generic Filesystem</displayName><version>4.0.0</version><description>These settings define where the project configurations and shell or batch script files are defined within this project. All paths are relative to the project root directory.</description><fields><headerTitle>Project Settings</headerTitle><fieldKey>configurationDirectoryRelativePath</fieldKey><fieldValue>scripts/config</fieldValue><label>Configuration Relative Path</label><type>TEXT</type><mandatory>true</mandatory><helpText>The configuration directory, relative to the project root directory. This is the root location of the projects environment specific configuration files.
                For this plugin this will primarily cnsist of dictionary files that contain environment specific search/replace tokens used
                to replace tempate tokens.</helpText><toolTipText>The configuration directory, relative to the project root directory.
                </toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Project Settings</headerTitle><fieldKey>templateDirectoryRelativePath</fieldKey><fieldValue>scripts/bin</fieldValue><label>Template directory Relative Path</label><type>TEXT</type><mandatory>true</mandatory><helpText>Relative path to the top level directory containing the filesystem templates.
                FileSystem templates may be whole filesystems or just some filtered files. use th FilesystemEnvironment plugin
                on the environment panel to determine which filter criteria should be used to take a snapshot that
                will be used as the basis for the template.</helpText><toolTipText>Relative path to the directory containing filesystem templates.</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><panelTitle>Generic Filesystem</panelTitle></data><pluginName>Filesystem (v4.0.0)</pluginName><pluginType>unknown</pluginType><pluginVersion>4.0.0</pluginVersion></projectPlugins><projectPlugins><active>true</active><data><name>FileSystem</name><displayName>File System</displayName><version>4.1.0</version><description/><fields><headerTitle>File System Scm Repository</headerTitle><fieldKey>rootDirectory</fieldKey><fieldValue>C:\midvision_4.0/projects/SCRIPT_DEMO_40</fieldValue><label>Project root directory</label><type>DIRECTORY</type><mandatory>true</mandatory><helpText>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.</helpText><toolTipText>The location on the RapidDeploy server where project artifacts will be written to.
                </toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>File System Scm Repository</headerTitle><fieldKey>deleteProjectFiles</fieldKey><fieldValue>true</fieldValue><label>Delete Project Files</label><listOfChoices>true,false</listOfChoices><type>CHECKONE</type><mandatory>false</mandatory><helpText>Project Files removal after project deletion.&lt;br/&gt;
                Generally, leave this as the default (false).&lt;/br&gt;
                When this is set in false, after project deletion, the files keep in the FS.&lt;/br&gt;
                Otherwise the project files are removed from the FS.
                </helpText><toolTipText>Enable/Disable Project Files removal after project deletion.</toolTipText><style/><classType>java.lang.Boolean</classType></fields><panelTitle>File System Scm Repository</panelTitle></data><pluginName>FileSystem (No SCM) (v4.2.0)</pluginName><pluginType>scm</pluginType><pluginVersion>4.2.0</pluginVersion></projectPlugins><projectPlugins><active>true</active><data><name>LocalFile</name><displayName>Local File</displayName><version>4.1.0</version><description>This is a file based aritfact respository&lt;br/&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.&lt;br/&gt;</description><fields><headerTitle>File Based Repository</headerTitle><fieldKey>buildStore</fieldKey><fieldValue>C:\midvision_4.0/buildstore</fieldValue><label>Build Store</label><type>DIRECTORY</type><mandatory>true</mandatory><helpText>The location on the RapidDeploy server where project deployment packages will be written to. This location may be shared with other projects.</helpText><toolTipText>The location on the RapidDeploy server where project deployment packages will be written to. This location may be shared with other projects.</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>File Based Repository</headerTitle><fieldKey>promotionStore</fieldKey><fieldValue>C:\midvision_4.0/promotionstore</fieldValue><label>Promotion Store</label><type>DIRECTORY</type><mandatory>true</mandatory><helpText>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.</helpText><toolTipText>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.</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>File Based Repository</headerTitle><fieldKey>deploymentPackageSearchString</fieldKey><fieldValue>SCRIPT_DEMO_40</fieldValue><label>Deployment Package Search String</label><type>TEXT</type><mandatory>true</mandatory><helpText>The string selector present in each deployment package to identify packages belonging to this project.</helpText><toolTipText>The string selector present in each deployment package to identify packages belonging to this project.</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>File Based Repository</headerTitle><fieldKey>supportLargeFiles</fieldKey><fieldValue>false</fieldValue><label>Support Large Files</label><listOfChoices>true,false</listOfChoices><type>CHECKONE</type><mandatory>false</mandatory><helpText>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.</helpText><toolTipText>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</toolTipText><style/><classType>java.lang.Boolean</classType></fields><panelTitle>File Based Repository</panelTitle></data><pluginName>Local FileSystem (v4.2.0)</pluginName><pluginType>artifact</pluginType><pluginVersion>4.2.0</pluginVersion></projectPlugins></projectPlugins>]]></pluginData>
      </pluginDataSet>
   </Project>
   <Project xmlns:ns2="http://www.midvision.com/rapiddeploy/domain/xml/resource" xmlns:ns3="http://www.midvision.com/rapiddeploy/domain/xml/resourcelist">
      <createDate>2016-05-13T10:55:13.474-03:00</createDate>
      <description>Run a script on a target server. Change the input environment variables and command line parameters per environment. (Maven)</description>
      <enabled>true</enabled>
      <logDirectory>C:/midvision_4.0/logs</logDirectory>
      <name>SCRIPT_DEMO_40_MVN</name>
      <optlock>0</optlock>
      <orchestrationFileName>midvision-deploy-orchestration.xml</orchestrationFileName>
      <owner>
         <description>This is the default MidVision Administrator</description>
         <email>support@midvision.com</email>
         <enabled>true</enabled>
         <firstname>MidVision</firstname>
         <lastname>Administrator</lastname>
         <optlock>245</optlock>
         <sourceType>1</sourceType>
         <username>mvadmin</username>
      </owner>
      <pluginDataSet>
         <id>179</id>
         <pluginData><![CDATA[<?xml version="1.0" encoding="UTF-8"?><projectPlugins><projectPlugins><active>true</active><data><name>FilesystemFiles</name><displayName>Generic Filesystem</displayName><version>4.0.0</version><description>These settings define where the project configurations and shell or batch script files are defined within this project. All paths are relative to the project root directory.</description><fields><headerTitle>Project Settings</headerTitle><fieldKey>configurationDirectoryRelativePath</fieldKey><fieldValue>scripts/config</fieldValue><label>Configuration Relative Path</label><type>TEXT</type><mandatory>true</mandatory><helpText>The configuration directory, relative to the project root directory. This is the root location of the projects environment specific configuration files.
                For this plugin this will primarily cnsist of dictionary files that contain environment specific search/replace tokens used
                to replace tempate tokens.</helpText><toolTipText>The configuration directory, relative to the project root directory.
                </toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Project Settings</headerTitle><fieldKey>templateDirectoryRelativePath</fieldKey><fieldValue>scripts/bin</fieldValue><label>Template directory Relative Path</label><type>TEXT</type><mandatory>true</mandatory><helpText>Relative path to the top level directory containing the filesystem templates.
                FileSystem templates may be whole filesystems or just some filtered files. use th FilesystemEnvironment plugin
                on the environment panel to determine which filter criteria should be used to take a snapshot that
                will be used as the basis for the template.</helpText><toolTipText>Relative path to the directory containing filesystem templates.</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><panelTitle>Generic Filesystem</panelTitle></data><pluginName>Filesystem (v4.0.0)</pluginName><pluginType>unknown</pluginType><pluginVersion>4.0.0</pluginVersion></projectPlugins><projectPlugins><active>true</active><data><name>FileSystem</name><displayName>File System</displayName><version>4.1.0</version><description/><fields><headerTitle>File System Scm Repository</headerTitle><fieldKey>rootDirectory</fieldKey><fieldValue>C:\midvision_4.0/projects/SCRIPT_DEMO_40_MVN</fieldValue><label>Project root directory</label><type>DIRECTORY</type><mandatory>true</mandatory><helpText>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.</helpText><toolTipText>The location on the RapidDeploy server where project artifacts will be written to.
                </toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>File System Scm Repository</headerTitle><fieldKey>deleteProjectFiles</fieldKey><fieldValue>true</fieldValue><label>Delete Project Files</label><listOfChoices>true,false</listOfChoices><type>CHECKONE</type><mandatory>false</mandatory><helpText>Project Files removal after project deletion.&lt;br/&gt;
                Generally, leave this as the default (false).&lt;/br&gt;
                When this is set in false, after project deletion, the files keep in the FS.&lt;/br&gt;
                Otherwise the project files are removed from the FS.
                </helpText><toolTipText>Enable/Disable Project Files removal after project deletion.</toolTipText><style/><classType>java.lang.Boolean</classType></fields><panelTitle>File System Scm Repository</panelTitle></data><pluginName>FileSystem (No SCM) (v4.2.0)</pluginName><pluginType>scm</pluginType><pluginVersion>4.2.0</pluginVersion></projectPlugins><projectPlugins><active>true</active><data><name>Maven</name><displayName>Maven</displayName><version>4.1.1</version><description/><fields><headerTitle>Maven Artifact Settings</headerTitle><fieldKey>mavenArtifactIdentifier</fieldKey><fieldValue>com.midvision.rapiddeploy.project:demo40-mvn:[0.0.0,)</fieldValue><label>Maven Artifact Identifier</label><type>TEXT</type><mandatory>true</mandatory><helpText>The artifact identifier.&lt;br/&gt;
                        Syntax: &amp;lt;groupId&amp;gt;:&amp;lt;artifactId&amp;gt;[:&amp;lt;extension&amp;gt;[:&amp;lt;classifier&amp;gt;]]:&amp;lt;version&amp;gt;, must not be null.&lt;br/&gt;
                        Example: org.apache.maven:maven-profile:[1.0.0,3.0.0) Resolves all versions between 1.0.0 and 3.0.0&lt;br/&gt;
                        Example: org.apache.maven:maven-profile:[1.0.0,) Resolves all versions between 1.0.0 and LATEST&lt;br/&gt;
                        </helpText><toolTipText>The artifact identifier. Syntax: &lt;groupId&gt;:&lt;artifactId&gt;[:&lt;extension&gt;[:&lt;classifier&gt;]]:&lt;version&gt;, must not be null.
                        Example: org.apache.maven:maven-profile:2.2.1</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Maven Artifact Settings</headerTitle><fieldKey>uploadToCentral</fieldKey><fieldValue>true</fieldValue><label>Sync to remote repository</label><listOfChoices>true,false</listOfChoices><type>CHECKONE</type><mandatory>false</mandatory><helpText>Synchronise local changes to the remote repository. If checked, any packages created locally
                        through RapidDeploy (Maven Local Repository) will be uploaded to the remote repository (Maven Remote Repository).
                        The remote repository/http server settings should allow POST operations (via WebDav) to the repository.</helpText><toolTipText>Sync to remote repository.</toolTipText><style/><classType>java.lang.Boolean</classType></fields><fields><headerTitle>Maven Artifact Repository</headerTitle><fieldKey>mavenLocalRepository</fieldKey><fieldValue>C:\midvision_4.0\buildstore</fieldValue><label>Maven Local Repository</label><type>TEXT</type><mandatory>true</mandatory><helpText>The location on the RapidDeploy server where project deployment packages will be written to. This location may be shared with other projects.
                RapidDeploy will create a local Maven repository at this location if it does not already exist.</helpText><toolTipText>The location on the RapidDeploy server where project deployment packages will be written to. This location may be shared with other projects.
                </toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Maven Artifact Repository</headerTitle><fieldKey>mavenRemoteRepositoryUrl</fieldKey><fieldValue>http://www.download.midvision.com/content/sites/Customer_Download/buildstore</fieldValue><label>Maven Remote Repository</label><type>TEXT</type><mandatory>true</mandatory><helpText>The remote location for the central maven repository. This location may be shared with other projects. May be blank if just using a local repository.</helpText><toolTipText>The remote location for the central maven repository. This location may be shared with other projects. May be blank if just using a local repository.</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Maven Artifact Repository</headerTitle><fieldKey>mavenUsername</fieldKey><fieldValue>midvision</fieldValue><label>Username</label><type>TEXT</type><mandatory>false</mandatory><helpText>Optional username to use to connect to the mvn Repository.</helpText><toolTipText>Optional username to use to connect to the mvn Repository.
                </toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Maven Artifact Repository</headerTitle><fieldKey>mavenPassword</fieldKey><fieldValue>{_MV@ENC#_}CGxrBJVTaf8FbTvHwZL0Ww==</fieldValue><label>Password</label><type>SECRET</type><mandatory>false</mandatory><helpText>The password to use to connect to the mvn Repository.</helpText><toolTipText>The password to use to connect to the mvn Repository.</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Maven Promotion Repository</headerTitle><fieldKey>promotionEnabled</fieldKey><fieldValue>true</fieldValue><label>Enable Promotion</label><listOfChoices>true,false</listOfChoices><type>CHECKONE</type><mandatory>true</mandatory><helpText>Enable / disable artifact promotion features.</helpText><toolTipText>Enable / disable artifact promotion from stating to release.</toolTipText><style/><classType>java.lang.Boolean</classType></fields><fields><headerTitle>Maven Promotion Repository</headerTitle><fieldKey>mavenLocalPromotionRepository</fieldKey><fieldValue>C:\midvision_4.0\promotionstore</fieldValue><label>Maven Local Promotion Repository</label><type>TEXT</type><mandatory>false</mandatory><helpText>The location on the RapidDeploy server where project deployment packages will be written to via promotion . This location may be shared with other projects.
                RapidDeploy will create a local Maven repository at this location if it does not already exist.</helpText><toolTipText>The location on the RapidDeploy server where project deployment packages will be written to via promotion . This location may be shared with other projects.
                </toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Maven Promotion Repository</headerTitle><fieldKey>mavenRemotePromotionRepositoryUrl</fieldKey><fieldValue>http://www.download.midvision.com/content/sites/Customer_Download/promotionstore</fieldValue><label>Maven Remote Promotion Repository</label><type>TEXT</type><mandatory>false</mandatory><helpText>The remote location for the promotion maven repository. This location may be shared with other projects. May be blank if just using a local promotion repository.</helpText><toolTipText>The remote location for the promotion maven repository. This location may be shared with other projects. May be blank if just using a local promotion repository.</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Maven Promotion Repository</headerTitle><fieldKey>mavenPromotionUsername</fieldKey><fieldValue>midvision</fieldValue><label>Username</label><type>TEXT</type><mandatory>false</mandatory><helpText>Optional username to use to connect to the maven promotion repository.</helpText><toolTipText>Optional username to use to connect to the maven promotion repository.
                </toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Maven Promotion Repository</headerTitle><fieldKey>mavenPromotionPassword</fieldKey><fieldValue>{_MV@ENC#_}fPYK7HKhfQajWkT4DAriwg==</fieldValue><label>Password</label><type>SECRET</type><mandatory>false</mandatory><helpText>The password to use to connect to the maven Repository.</helpText><toolTipText>The password to use to connect to the maven Repository.</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Proxy Connection Settings</headerTitle><fieldKey>mavenProxyHostname</fieldKey><fieldValue/><label>Proxy Hostname</label><type>TEXT</type><mandatory>false</mandatory><helpText>Optional proxy server hostname(if required).</helpText><toolTipText>Optional proxy server hostname (if required).
                </toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Proxy Connection Settings</headerTitle><fieldKey>mavenProxyPort</fieldKey><fieldValue/><label>Proxy Port</label><type>TEXT</type><mandatory>false</mandatory><helpText>Optional port to use to connect to the proxy server (if required).</helpText><toolTipText>Optional port to use to connect to the proxy server (if required).</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Proxy Connection Settings</headerTitle><fieldKey>mavenProxyUsername</fieldKey><fieldValue/><label>Proxy Username</label><type>TEXT</type><mandatory>false</mandatory><helpText>Optional username to use to connect to the proxy server (if required).</helpText><toolTipText>Optional username to use to connect to the proxy server (if required).
                </toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><fields><headerTitle>Proxy Connection Settings</headerTitle><fieldKey>mavenProxyPassword</fieldKey><fieldValue/><label>Proxy Password</label><type>SECRET</type><mandatory>false</mandatory><helpText>Optional password to use to connect to the proxy server (if required).</helpText><toolTipText>Optional password to use to connect to the proxy server (if required).</toolTipText><style>width: 50em;</style><classType>java.lang.String</classType></fields><panelTitle>Maven Artifact Repository</panelTitle></data><pluginName>Maven 2 (v4.2.1)</pluginName><pluginType>artifact</pluginType><pluginVersion>4.2.1</pluginVersion></projectPlugins></projectPlugins>]]></pluginData>
      </pluginDataSet>
   </Project>
</projects>