Develop > Appendix A: API return examples > Get package properties example

Get package properties example

Retrieves the properties that are parameterized in the package for each component of the application design.

The following URL was sent:

https://localhost:8444/csa/api/codar/app-package/07c979d2-afe0-4cc8-a607-8cbf780ed725/properties

The following parameter was sent:

packageId

The following JSON was returned:

{ "members" : [ { "icon" : "/csa/designer//csa/api/blobstore/Tools1.png?tag=library", "@self" : "/csa/api/package/component/New_PetDB_855ff95b_fde7_432e_b4dd_b7f7e8c2ba67_e6b6ca0914a34eec93438670d70e55e4__VERSION__1__GROUPID__com.hp.csa.type0002", "description" : "Creates Pet Clinic Database on the database server", "@type" : "urn:x-hp:2012:software:cloud:data_model:package", "name" : "PetClinic DB Conf", "provider" : null, "properties" : [ { "modifiable" : false, "name" : "mysqlusername", "value" : "root", "enumeration" : null, "displayName" : "mysqlusername", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "port", "value" : "22", "enumeration" : null, "displayName" : "port", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "servicecommand", "value" : "sh /tmp/mysqldb_conf.sh", "enumeration" : null, "displayName" : "servicecommand", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "remotefilepath", "value" : "/tmp/", "enumeration" : null, "displayName" : "remotefilepath", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "mysqlpassword", "value" : "password", "enumeration" : null, "displayName" : "mysqlpassword", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : true }, { "modifiable" : false, "name" : "configurationurl", "value" : "http://10.1.4.233:8085/userContent/mysqldb_conf.sh", "enumeration" : null, "displayName" : "configurationurl", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false } ], "displayName" : "PetClinic DB Conf" }, { "icon" : "/csa/designer//csa/api/blobstore/pets.png?tag=library", "@self" : "/csa/api/package/component/NewPetClinicApplication_be9f0cf28800410cb95b57179fa310fd__VERSION__1__GROUPID__com.hp.csa.type0001", "description" : "PetClinic Application", "@type" : "urn:x-hp:2012:software:cloud:data_model:package", "name" : "PetClinic Application", "provider" : null, "properties" : [ { "modifiable" : false, "name" : "port", "value" : "22", "enumeration" : null, "displayName" : "port", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "servicecommand", "value" : "sh /tmp/petclinic_jdbc_conf.sh", "enumeration" : null, "displayName" : "servicecommand", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "localfilepath", "value" : "petclinic.war", "enumeration" : null, "displayName" : "localfilepath", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "remotefilepath", "value" : "/tmp/", "enumeration" : null, "displayName" : "remotefilepath", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "artifacturl", "value" : "http://pavan-alm.cdl.local:8652/job/Pavan_Maven%20Project/27/artifact/Petclinic/target/petclinic.war", "enumeration" : null, "displayName" : "artifacturl", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "configurationurl", "value" : "http://10.1.4.233:8085/userContent/petclinic_jdbc_conf.sh", "enumeration" : null, "displayName" : "configurationurl", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false } ], "displayName" : "PetClinic Application" }, { "icon" : "/csa/designer//csa/api/blobstore/tomcat.png?tag=library", "@self" : "/csa/api/package/component/Tomcat_Server_c2bc9714_19c3_488b_bdd0_37ee9544a21f_aade4fa90c4a4c8397d9a9bf4d141949__VERSION__1__GROUPID__com.hp.csa.type0001", "description" : "Apache Tomcat Application Server", "@type" : "urn:x-hp:2012:software:cloud:data_model:package", "name" : "Tomcat Application Server", "provider" : null, "properties" : [ { "modifiable" : false, "name" : "remoteFilePath", "value" : "/tmp/", "enumeration" : null, "displayName" : "remoteFilePath", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "configurationUrl", "value" : "http://10.1.4.233:8085/userContent/install_tomcat.sh", "enumeration" : null, "displayName" : "configurationUrl", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "sshPort", "value" : "22", "enumeration" : null, "displayName" : "sshPort", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "installPath", "value" : "/opt/tomcat7", "enumeration" : null, "displayName" : "installPath", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "artifactUrl", "value" : "http://10.1.6.81:8082/job/software_repository/ws/tomcat7/core/apache-tomcat-7.0.56.tar.gz", "enumeration" : null, "displayName" : "artifactUrl", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "serviceCommand", "value" : "sh install_tomcat.sh", "enumeration" : null, "displayName" : "serviceCommand", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false } ], "displayName" : "Tomcat Application Server" }, { "icon" : "/csa/designer//csa/api/blobstore/mysql.png?tag=library", "@self" : "/csa/api/package/component/MySQL_Database_20509e36_558f_4502_ba03_f76f5d879afb_f21f3034d7ea4431981b737d81ce6299__VERSION__1__GROUPID__com.hp.csa.type0001", "description" : "MySQL Database Server", "@type" : "urn:x-hp:2012:software:cloud:data_model:package", "name" : "MySQL Database", "provider" : null, "properties" : [ { "modifiable" : false, "name" : "remoteFilePath", "value" : "/tmp/", "enumeration" : null, "displayName" : "remoteFilePath", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "configurationUrl", "value" : "http://10.1.4.233:8085/userContent/install_mysql.sh", "enumeration" : null, "displayName" : "configurationUrl", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "sshPort", "value" : "22", "enumeration" : null, "displayName" : "sshPort", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "artifactUrl", "value" : "http://10.1.6.81:8082/job/software_repository/ws/mysql56/mysql-server_5.6.21-1ubuntu12.04_amd64.deb-bundle.tar", "enumeration" : null, "displayName" : "artifactUrl", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "serviceCommand", "value" : "sh install_mysql.sh", "enumeration" : null, "displayName" : "serviceCommand", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false } ], "displayName" : "MySQL Database" }, { "icon" : "/csa/designer/pluginResources/topology/icons/SERVER.svg", "@self" : "/csa/api/package/component/VcenterServerType__VERSION__04.20.0000__GROUPID__com.hp.csa.type0001", "description" : "vCenter Server", "@type" : "urn:x-hp:2012:software:cloud:data_model:package", "name" : "vCenter Server", "provider" : "VMWARE_VCENTER", "properties" : [ { "modifiable" : false, "name" : "vmTemplateReference", "value" : "ubuntu1204-hemant", "enumeration" : null, "displayName" : "vmTemplateReference", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "customizationSpec", "value" : "useVmName_Linux", "enumeration" : null, "displayName" : "customizationSpec", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "vmNamePrefix", "value" : "app", "enumeration" : null, "displayName" : "vmNamePrefix", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false } ], "displayName" : "vCenter Server" }, { "icon" : "/csa/designer/pluginResources/topology/icons/SERVER.svg", "@self" : "/csa/api/package/component/VcenterServerType__VERSION__04.20.0000__GROUPID__com.hp.csa.type0002", "description" : "vCenter Server", "@type" : "urn:x-hp:2012:software:cloud:data_model:package", "name" : "vCenter Server", "provider" : "VMWARE_VCENTER", "properties" : [ { "modifiable" : false, "name" : "vmTemplateReference", "value" : "ubuntu1204-hemant", "enumeration" : null, "displayName" : "vmTemplateReference", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : true, "name" : "cpuCount", "value" : null, "enumeration" : null, "displayName" : "cpuCount", "type" : "BigDecimal", "modifiableDuringModification" : true, "required" : false, "confidential" : false }, { "modifiable" : true, "name" : "memorySize", "value" : null, "enumeration" : null, "displayName" : "memorySize", "type" : "BigDecimal", "modifiableDuringModification" : false, "required" : false, "confidential" : false }, { "modifiable" : false, "name" : "customizationSpec", "value" : "useVmName_Linux", "enumeration" : null, "displayName" : "customizationSpec", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false }, { "modifiable" : false, "name" : "vmNamePrefix", "value" : "db", "enumeration" : null, "displayName" : "vmNamePrefix", "type" : "String", "modifiableDuringModification" : false, "required" : true, "confidential" : false } ], "displayName" : "vCenter Server" } ] }