latestOpenAPI 3.0.12026-08-20112309904.6 KB
466169815b78
Collections - Network
Get tree graph for a collection
⚠️ DEPRECATED - This endpoint is deprecated and will be removed at the end of December 2026.
Note: Responses include a Sunset HTTP header (RFC 8594) indicating the removal date.
Retrieve a hierarchical tree structure showing supplier relationships within a collection.
This endpoint returns a tree graph representing the supply chain network, showing how suppliers are connected through multiple tiers. Each node in the tree represents a target (supplier/customer), and edges represent relationships between them.
Use Cases:
- Visualize supplier network structure
- Analyze supply chain depth and breadth
- Identify direct and indirect suppliers
- Map relationships across multiple tiers
Filtering Options:
- commodityIds: Filter results to include only targets associated with specific commodities
- commodityTreeId: Filter using a predefined commodity tree
- tierLevel: Limit the depth of the tree (maximum 4 tiers)
- fetchParents: Include parent organizations in the results
Response Format: Returns an array of tree nodes, where each node contains:
- Target information
- Supplier relationships (nested structure)
- Tier information
- Edge source information
Required Permissions: ACCESS_PUBLIC_TREE_GRAPH and READ on the collection
Performance Impact: High
get/public/v1/network/{collectionId}/tree-graph
Path parameters
collectionIdinteger required
Query parameters
commodityIdsinteger[]
commodityTreeIdinteger
fetchParentsboolean
tierLevelinteger
Response
OK