/api/factories/{refNo}/{version} (Get factory by version)

Get factory by version

GET/api/factories/{refNo}/{version}

Use it in a workflow

Add a step and choose the TradeBeyond connector.
Pick the /api/factories/{refNo}/{version} (Get factory by version) action (under FactoryController).
Fill in the fields below, then reference the result from later steps as {{apiFactoriesRefnoVersionGetFactoryByVersion.response.data}}.

Request

Path parameters

refNostringrequired

versioninteger (int32)required

Response

Returns 200 with an object. Read it in later steps with {{apiFactoriesRefnoVersionGetFactoryByVersion.response.data.<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
  }
}

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

Was this page helpful?