younifyd
Menu

/api/factories/relatedHierarchy (Factory Hierarchy)

Factory Hierarchy

POST/api/factories/relatedHierarchy

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/factories/relatedHierarchy (Factory Hierarchy) action (under FactoryController).
  3. Fill in the fields below, then reference the result from later steps as {{apiFactoriesRelatedhierarchyFactoryHierarchy.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

idstring
refNostring
versioninteger (int32)
businessNamestring
factCodestring
factAuditNostring
baselineYearCodestring
editingStatusstring
statusstring
factTypeValuestring
baselineEmissionsinteger (int64)
countryobject
codestringrequired
namestring
versioninteger (int32)
energyTrackingListarray<object>
yearobject3 fields
energyUnitobject3 fields
energySourceobject3 fields
heatValuenumber
emissionFactornumber
json
{
  "id": "string",
  "refNo": "string",
  "version": 0,
  "businessName": "string",
  "factCode": "string",
  "factAuditNo": "string",
  "baselineYearCode": "string",
  "editingStatus": "string",
  "status": "string",
  "factTypeValue": "string",
  "baselineEmissions": 0,
  "country": {
    "code": "string",
    "name": "string",
    "version": 0
  }
}

Response

Returns 200 with a array<object>. Read it in later steps with {{apiFactoriesRelatedhierarchyFactoryHierarchy.response.data.<field>}}.

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.