younifyd
Menu

/api/factories (Execute factory action)

Execute factory action

POST/api/factories

Use it in a workflow

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

Request

Query parameters

actionstringrequired

One ofNONEREFRESH_ITEMSAMENDEDITEDIT_CANCELSAVELOAD_DOCSAVE_AND_CONFIRMLOAD_VIEW_DEFINITIONDONE_DOCSEND_TO_VENDORSEND_TO_BUYERMARK_AS_OUT_OF_SIGNATUREMARK_AS_SIGNEDSEND_REMINDER_TO_VENDORSUBMITSET_TO_ACTIVESET_TO_INACTIVESET_TO_CANCELEDSET_AS_DEFAULTMARK_AS_CONCEPTMARK_AS_COSTINGMARK_AS_ADOPTEDMARK_AS_FINALIZEDMARK_AS_QUOTEDMARK_AS_SHORTLISTEDREMOVE_FROM_SHORTLISTMARK_AS_CONFIRMTOBUYMARK_AS_REJECTTOBUYMARK_AS_REVISEMARK_AS_PROPOSEDMARK_AS_OVERRIDDENMARK_AS_SOURCINGMARK_AS_PHASE_1_TRACKING_COMPLETEDMARK_AS_DRAFTMARK_AS_OFFICIALMARK_AS_READY_FOR_ONBOARDINGMARK_AS_CONFIRMEDMARK_AS_DEFAULTMARK_AS_SUBMITTED

docModestring

One ofREADEDITDefault "EDIT"

approvalTemplateIdstring
isNeedRecalculateboolean
skipVersionboolean

Default false

asyncIndexboolean

Default false

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 an object. Read it in later steps with {{apiFactoriesExecuteFactoryAction.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.