Get topology relationship data
This API provides clients with comprehensive access to full topology relationship data, offering a detailed view of the interconnections between resources within a system. It facilitates seamless data synchronization and supports advanced topology visualization by enabling the extraction of key relationship details.
Path Parameters
- clientId
Describes the clientId of the tenant
Query Parameters
- pageSize
Specifies the number of results to display per page, ranging from 1 to 500.
- pageNo
Specifies the page number to retrieve, such as 1.
- relation
Filters relationships based on specific types. Accepted values include: manages, managed by, contains, contained in, provides, initiates, powers, post data, receive data, uses, used by, hosts, consumes, impacts, defines, runs on, hosted on, supported by, depends, consumes, registered on, impacts, deps, topology, NetworkTopology, running, connects, memberof, associatewith, ClusterOf, belongsTo, attachedto, componentOf.
- queryNode
Defines the resource node, such as resourceName:index-dev-4. Using the queryNode, you can filter relationship data associated with the source node. All attributes within the source node are available for filtering. The attributes that can be used to refine the data are: name, sourceType, entityType, resourceType, isDevice, uuid, hostName, aliasName, resourceName, active, state, nativeType. In some instances, specific attributes may be unavailable for a source node, which means that the corresponding filters will not be applicable to that node. For example, if you're aiming to filter by resourceType and nativeType, you could use the following syntax: resourceType:CISCO_MERAKI_NETWORK%2bnativeType:Networks This enables you to refine your data retrieval based on the specific attributes of the source node, allowing you to obtain the precise relations you are interested in.
- queryLink
Specifies a link using the internal application ID.
Responses
- results
- totalResults
- pageNo
- pageSize
- totalPages
- nextPage
- nextPageNo
- descendingOrder