What's on this page

Topology

Associated with each example is a table explaining the fields in the example. This includes the name of the field, a brief description and whether the field is mandatory. Whether a field is required or not is based on the context of the examples. The underlying API definition may mark a field as optional, but in some contexts, the fields must be supplied.

In the examples below field names shown in italics are example names and not the real one to be used in messages.

Get Assembly by Id

Gets the assembly with the given id.

Request Format

Aspect Value
Endpoint URL /api/topology/assemblies/{assemblyId}
HTTP Method GET

Request parameters

Field Description Mandatory
id The internal id of the assembly. Yes
numEvents Number of historical events to show in response. If numEvents is set to 0, only the structure of assembly is shown. If left blank, default value 3 is used. No

Response Format

Aspect Value
Response Code 200 Ok

Example Response

{

  "type": "Assembly",

  "id": "bf649336-c8c5-49d9-9f4e-60567fe54135",

  "name": "test_1",

  "state": "Active",

  "descriptorName": "assembly::t_bta::1.0",

  "properties": [

​    {

​      "name": "data",

​      "value": "data"

​    },

​    …

  ],

  "createdAt": "2017-08-02T22:28:41.906+0000",

  "lastModifiedAt": "2017-08-02T22:47:46.189+0000",

  "children": [

​    {

​      "type": "Component",

​      "id": "aa56626d-cfec-410b-afb7-7160019bdff0",

​      "name": "test_1__A",

​      …

  ],

  "relationships": [

​    {

​      "name": "third-relationship__1",

​      "sourceId": "aa56626d-cfec-410b-afb7-7160019bdff0",

​      "targetId": "9c525d0c-18d4-404f-a5b2-8a55480660a8",

​      "properties": [

​        {

​          "name": "source",

​          "value": "test_1__A"

​        }

​      ]

​    }

  ],

  "references": [

​    {

​      "id": "1c269f9d-fcca-4754-946c-6f3e6179bf38",

​      "name": "internal-network",

​      "type": "resource::openstack_neutron_network::1.0",

​      …

​    },

​     …

  ]

}

Response properties

Field Description Mandatory
type The type of entity being returned – Always “Assembly” Yes
id The internal id of the assembly Yes
name The name of the assembly as provided by the external system Yes
state the state of the assembly. Allowed values: Installed, Inactive, Active. This field may be missing if the assembly has not reached the Installed state No
descriptorName The name of the assembly descriptor associated with the assembly instance Yes
properties A collection of assembly level properties. Each property will have a name and value field Yes
createdAt The date and time the assembly was created Yes
lastModifiedAt The date and time the assembly was last modified No
children A collection of components that make up the assembly. When the component is of ‘type’ ‘Assembly’ the contents are the same as for the top level assembly. When the ‘type’ is ‘component’ the entry is in fact a resource. This will have a type, name and id and a set of associated properties. Yes
relationships A collection of relationships associated with the assembly instance. Each relationship has a name and the id of the source and target components involved in the relationship. Relationships also have a property section No
references A collection of references used by the assembly. References can be to resources provided by resource managers but not created using any assembly and other existing assembly instances. For references the No

Get Assembly by Name

A request to get the assembly with the given name.

Request Format

Aspect Value
Endpoint URL /api/topology/assemblies?name={name}
HTTP Method GET

Request parameters

Field Description Mandatory
name The name of the assembly. Yes
numEvents Number of historical events to show in response. If numEvents is set to 0, only the structure of assembly is shown. No

Response Format

Aspect Value
Response Code 200 Ok

Example Response

{

  "type": "Assembly",

  "id": "bf649336-c8c5-49d9-9f4e-60567fe54135",

  "name": "test_1",

  "state": "Active",

  "descriptorName": "assembly::t_bta::1.0",

  "properties": [

​    {

​      "name": "data",

​      "value": "data"

​    },

​    …

  ],

  "createdAt": "2017-08-02T22:28:41.906+0000",

  "lastModifiedAt": "2017-08-02T22:47:46.189+0000",

  "children": [

​    {

​      "type": "Component",

​      "id": "aa56626d-cfec-410b-afb7-7160019bdff0",

​      "name": "test_1__A",

​      …

  ],

  "relationships": [

​    {

​      "name": "third-relationship__1",

​      "sourceId": "aa56626d-cfec-410b-afb7-7160019bdff0",

​      "targetId": "9c525d0c-18d4-404f-a5b2-8a55480660a8",

​      "properties": [

​        {

​          "name": "source",

​          "value": "test_1__A"

​        }

​      ]

​    }

  ],

  "references": [

​    {

​      "id": "1c269f9d-fcca-4754-946c-6f3e6179bf38",

​      "name": "internal-network",

​      "type": "resource::openstack_neutron_network::1.0",

​      …

​    },

​     …

  ]

}

Response properties

Field Description Mandatory
type The type of entity being returned – Always “Assembly” Yes
id The internal id of the assembly Yes
name The name of the assembly as provided by the external system Yes
state the state of the assembly. Allowed values: Installed, Inactive, Active. This field may be missing if the assembly has not reached the Installed state No
descriptorName The name of the assembly descriptor associated with the assembly instance Yes
properties A collection of assembly level properties. Each property will have a name and value field Yes
createdAt The date and time the assembly was created Yes
lastModifiedAt The date and time the assembly was last modified No
children A collection of components that make up the assembly. When the component is of ‘type’ ‘Assembly’ the contents are the same as for the top level assembly. When the ‘type’ is ‘component’ the entry is in fact a resource. This will have a type, name and id and a set of associated properties. Yes
relationships A collection of relationships associated with the assembly instance. Each relationship has a name and the id of the source and target components involved in the relationship. Relationships also have a property section No
references A collection of references used by the assembly. References can be to resources provided by resource managers but not created using any assembly and other existing assembly instances. For references the No