PRprewave
Collections - Network (deprecated)

Get tree graph for a collection

Changed on

⚠️ DEPRECATED - This endpoint is deprecated and will be removed on 31 May 2027.

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

Request

Path parameters

collectionIdinteger required

Query parameters

commodityIdsinteger[]
commodityTreeIdinteger
fetchParentsboolean
tierLevelinteger

Response

OK

suppliersPublicTreeTargetV1[] required circular
edgeSourcestring required
filteredboolean required

Example response

[
  {
    "target": {
      "id": 102006215,
      "name": "Høyanger",
      "sname": "3191281",
      "description": "Description shown in the target profile",
      "location": "Mistelbach",
      "yearFounded": 1999,
      "screened": true,
      "screenedStatus": "Screened",
      "linkedInId": "general-motors",
      "ctype": {
        "id": 1234,
        "ctype": "mine",
        "targetTypeId": 1234,
        "displayName": "Mine",
        "pluralName": "Mines",
        "icon": "fas fa-mine",
        "bgColor": "#ff0000",
        "textColor": "#ffffff"
      },
      "foreignSystems": [
        {
          "id": "1234",
          "source": "SAP_ARIBA"
        }
      ]
    }
  }
]

Changes

  • cedf01f35c95Revision changes
    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

  • 0ab68d9081f9Revision changes
    • info

      response property items/target/earliestAlert deprecated