Develop > Appendix A: API return examples > List the candidate topologies that can fulfill the specified partial topology example

List the candidate topologies that can fulfill the specified partial topology example

Lists the candidate topologies that can fulfill the specified partial topology.

The following example shows a partial design with two requirements, ApplicationServer and DatabaseServer. The initial members array provides the service designs, which are topologies that can satisfy all requirements. After the initial members array, the requirements member array contains details of microservices per requirement (exclusive of the service designs.)

The following URL was sent:

https://localhost:8444/csa/api/ui/topology-model/composition/9dc7a8f7-9a11-4d4f-a149-6e5b3aeb7618/candidateTopology

The following JSON was returned:

{
   "@count" : 1,
    "members" : [ {
       "@type" : "urn:x-hp:2013:software:cloud:topology_model:topology",
      "@self" : "/csa/api/topology-model/topology/9dc7a8f7-9a11-4d4f-a149-6e5b3aeb7618",
      "id" : "9dc7a8f7-9a11-4d4f-a149-6e5b3aeb7618",
      "iconUrl" : "/csa/designer/img/noimage-lightgray.svg",
      "displayName" : "Allin1",
      "displayNameWithVersion" : "Allin1 - 1.0.0"
      "description" : "",
      "version" : "1.0.0",
      "artifactId" : "f20b7a8b-0abe-454b-b6d4-cd45764e70c4",
      "groupId" : "com.hp.csa",
      "published" : false,
      "tagIds" : [ ]
} ],
"requirements" : {
   "count" : 2,
   "members" : [ {
     "id" : "dc3ec34b-a8d1-e588-fee1-49d3b0c900ad",
     "displayName" : "ApplicationServer",
     "scalingGroupId" : "",
     "scalingGroupName" : "",
     "matchingTopologies" : {
       "count" : 1,
        "members" : [ {
         "@type" : "urn:x-hp:2013:software:cloud:topology_model:topology",
                 "@self" : "/csa/api/topology-model/topology/9dc7a8f7-9a11-4d4f-a149-6e5b3aeb7618",
         "id" : "9dc7a8f7-9a11-4d4f-a149-6e5b3aeb6728",
         "iconUrl" : "/csa/designer/img/noimage-lightgray.svg",
            "displayName" : "Tomcat_Infra",
         "displayNameWithVersion" : "Allin1 - 1.0.0"
         "description" : "",
         "version" : "1.0.0",
            "artifactId" : "f20b7a8b-0abe-454b-b6d4-cd45764e62c4",
         "groupId" : "com.hp.csa",
         "published" : false,
         "tagIds" : [ ]
        } ]
     }
   }, {
     "id" :"4ea90e2a-a7b0-3185-d348-868f259235c1",
    "displayName" : "DatabaseServer",
        "scalingGroupId" : "7b0e62d9-ca22-4128-a7d2-df45f6ec2a6a",
     "scalingGroupName" : "micro_mixed",
     "matchingTopologies" : {
       "count" : 2,
        "members" : [ {
         "@type" : "urn:x-hp:2013:software:cloud:topology_model:topology",
         "@self" : "/csa/api/topology-model/topology/69efd92b-4be7-480c-abb9-e54948f5e2f1",
         "id" : "69efd92b-4be7-480c-abb9-e54948f5e2f1",
          "iconUrl" : "/csa/designer/img/noimage-lightgray.svg",
         "displayName" : "SQL_Infra",
         "displayNameWithVersion" : "SQL_Infra- 1.0.0"
         "description" : "",
         "version" : "1.0.0",
         "artifactId" : "77b8d440-4a75-4c77-94e9-66ebf136f781",
         "groupId" : "com.hp.csa",
         "published" : false,
         "tagIds" : [ ]
        }, {
         "@type" : "urn:x-hp:2013:software:cloud:topology_model:topology",
         "@self" : "/csa/api/topology-model/topology/e535c5cf-28fd-483e-a8d0-792627f7a7b6",
         "id" : "e535c5cf-28fd-483e-a8d0-792627f7a7b6",
         "iconUrl" : "/csa/designer/img/noimage-lightgray.svg",
         "displayName" : "Orcl_Infra",
         "displayNameWithVersion" : "Orcl_Infra- 1.0.0"
         "description" : "",
         "version" : "1.0.0",
         "artifactId" : "d068b895-dd53-4ba2-82db-946b1a77bb59",
         "groupId" : "com.hp.csa",
         "published" : false,
         "tagIds" : [ ]
       } ]
     }
   }
   } ]
  }
}
}
}