PRprewave
Collections - Network (deprecated)

Get commodity graph for a commodity tree

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.

Migration Required

This endpoint has been replaced by the v2 Network API. Please migrate to the new endpoint:

Replacement Endpoint

Old EndpointNew EndpointPurpose
GET /public/v1/network/tree/{commodityTreeId}/commodity-graphGET /public/v2/network/tree/{commodityTreeId}/commodity-graphGet commodity graph for a commodity tree

Why Migrate?

The v2 Network API provides improvements:

1. Enhanced Response Structure

  • v1: Returns PublicTreeTargetV1 structure
  • v2: Returns PublicTreeTargetV2 structure with additional metadata
  • v2: Better organized response format

2. Improved Consistency

  • v2: Aligned with other v2 API endpoints
  • v2: Consistent response structures across network endpoints

3. Better Documentation

  • Comprehensive examples for all endpoints
  • Detailed error response documentation
  • Clear parameter descriptions

Quick Migration Guide

Step 1: Update Endpoint URL

Before:

GET /public/v1/network/tree/456/commodity-graph

After:

GET /public/v2/network/tree/456/commodity-graph

Step 2: Update Response Parsing

Before: Parse PublicTreeTargetV1 structure

After: Parse PublicTreeTargetV2 structure (may have additional fields)

Breaking Changes

  1. Endpoint Path: Changed from /public/v1/network/tree/{commodityTreeId}/commodity-graph to /public/v2/network/tree/{commodityTreeId}/commodity-graph
  2. Response Structure: Returns PublicTreeTargetV2 instead of PublicTreeTargetV1 (may have additional fields)

Required Permission: ACCESS_PUBLIC_COMMODITY_GRAPH

Performance Impact: High

get/public/v1/network/tree/{commodityTreeId}/commodity-graph

Request

Path parameters

commodityTreeIdinteger required

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