REST API

Interactions with the Topology Service take place through a REST API. API calls and Swagger documentation links are listed in this section. Use the Swagger documentation to access more detailed information.

REST API calls and default Swagger links

The REST API calls are grouped together into different sections. If installed on localhost, then the Swagger documentation can be accessed at the following link: https://localhost/1.0/topology/swagger/

Composites: The API calls in the composites section of the Merge Service allow you to view which resources have been merged into composites and to create and change them.; https://localhost/1.0/merge/swagger/#/Composites

Groups: The API calls in the groups section allow you to create a vertex which represents a group and then to associate other resource vertices with that group.; https://localhost/1.0/topology/swagger/#/Groups
Management artifacts: The Management artifacts calls provide the means to associate non-resource vertices, such as tests, with resource vertices.; https://localhost/1.0/topology/swagger/#/Management_Artifacts
Metadata: Metadata provides the means to store data in a metaData vertex, which can then be associated with a resource vertex using the metadataFor edge type.; https://localhost/1.0/topology/swagger/#/Metadata
Resources: The most common calls.; These API calls are used to create, update and delete resource vertices in the topology. It also includes API calls to create, update and delete edges between resources.; https://localhost/1.0/topology/swagger/#/Resources
Note: The topology service has a history model which allows it to retain information on the historical resource properties and edges for 30 days. The Resources methods will take an _at query parameter, which will cause them to return what the topology previously looked like at a specific point in time. This allows the UI to visualize the topology as it was in the past.
Rules: The API calls in the rules section of the Merge Service allow you to view which merge rules have been defined and to create or update merge rules.; https://localhost/1.0/merge/swagger/#/Rules
Schema: The schema API calls can be used to query the Topology Service for information about the types of entities which exist within the topology.; https://localhost/1.0/topology/swagger/#/Schema
Service info: The Service info API calls include a health check call, and a call to return the current Topology Service version.; https://localhost/1.0/topology/swagger/#/Service_Info
Status: The status API provides methods to associate and manipulate the status that is associated with a given resource.; https://localhost/1.0/topology/swagger/#/Types
Tenants: The Tenants API provides a mechanism by which resource, metadata and management artifacts can be made globally readable by multiple tenants.; https://localhost/1.0/topology/swagger/#/Tenants
Types: These return information on the entity types which have been instantiated.; Tip: This includes the _include_count query parameter, which you can use to return a time-stamped count of both the number of types, and number of instances of each type.; https://localhost/1.0/topology/swagger/#/Types