Browsing assembly instances

You can browse the assemblies in the instance repository by retrieving the most recently updated assemblies, querying for individual assemblies, or querying for assemblies with names that match a regular expression.

Use the following links to learn how to retrieve assembly instances:

Retrieving the most recently updated assemblies

Retrieve the 20 assembly instances that have the latest modification date by running the following command:
GET api/v1/topology/assemblies
Information about the higher-level assemblies is shown, including their names, IDs, and the last transition to their current state. For example, you might see output like this sample output: 
[
	{
		"id": "479c793c-9866-4baf-9054-1169b9c555f1",
		"name": "example_1",
		"descriptorName": "assembly::empty_descriptor::1.0",
		"state": "Active",
		"lastTransition": {
...
		}
	},
	{
		"id": "5e87fba9-7a41-473b-aed4-fd822bd03353",
		"name": "test_2",
		"descriptorName": "assembly::empty_descriptor::1.0",
		"state": "Active",
		"lastTransition": {
...
		}
	},
	{
		"id": "9fb36830-513a-4d5d-8a32-70861a820dbc",
		"name": "test_1",
		"descriptorName": "assembly::empty_descriptor::1.0",
		"state": "Active",
		"lastTransition": {
...
		}
	}
]

Retrieving individual assemblies

Retrieve specific assemblies by using the assembly ID or the assembly name.

To retrieve an assembly by using the assembly ID, run this command: 
GET api/v1/topology/assemblies/<assembly_id>
For example: 
GET api/v1/topology/assemblies/9fb36830-513a-4d5d-8a32-70861a820dbc
To retrieve an assembly by using the assembly name, run this command: 
GET api/v1/topology/assemblies/?name=<assembly_name>
For example: 
GET api/v1/topology/assemblies/?name=test_1
Information about the assembly, like the following sample output, is shown: 
{
		"type": "Assembly",
		"id": "9fb36830-513a-4d5d-8a32-70861a820dbc",
		"name": "test_1",
		"descriptorName": "assembly::empty_descriptor::1.0",
		"createdAt": "2022-07-12T10:55:23.379615Z",
		"lastModifiedAt": "2022-07-12T12:17:54.021122Z",
		"state": "Active"
	}

Retrieving assemblies with names that match a pattern

You can use the nameContains parameter to filter the list of assemblies that are retrieved. Only those assemblies with names that match the specified regular expression are shown.

Run the following command to filter the list of assemblies that are retrieved: 
GET api/v1/topology/assemblies/?nameContains=<assembly_name_pattern>
Here are some examples of how you can use regular expressions to filter the list of assemblies:
  • Retrieve all assemblies where the assembly name contains test by running this command: 
    GET api/v1/topology/assemblies/?nameContains=test
    Information about all the assemblies that match the regular expression are shown. For example: 
    {
	"assemblies": [
		{
			"id": "9fb36830-513a-4d5d-8a32-70861a820dbc",
			"name": "test_1",
...
		},
		{
			"id": "5e87fba9-7a41-473b-aed4-fd822bd03353",
			"name": "test_2",
...
		}
	],
	"partial": false
}
  • Retrieve all assemblies where the assembly name ends with _1 by running this command: 
    GET /api/v1/topology/assemblies?nameContains=.*_1$
    Information about all the assemblies that match the regular expression are shown. For example: 
    {
	"assemblies": [
		{
			"id": "479c793c-9866-4baf-9054-1169b9c555f1",
			"name": "example_1",
...
		},
		{
			"id": "9fb36830-513a-4d5d-8a32-70861a820dbc",
			"name": "test_1",
...
		}
	],
	"partial": false
}