younifyd
Menu

/api/hcls/{refNo}/{version} (Get hierarchicalCode by version)

Get hierarchicalCode by version

GET/api/hcls/{refNo}/{version}

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/hcls/{refNo}/{version} (Get hierarchicalCode by version) action (under HierarchicalCodeListController).
  3. Fill in the fields below, then reference the result from later steps as {{apiHclsRefnoVersionGetHierarchicalcodeByVersion.response.data}}.

Request

Path parameters

refNostringrequired
versioninteger (int32)required

Response

Returns 200 with an object. Read it in later steps with {{apiHclsRefnoVersionGetHierarchicalcodeByVersion.response.data.<field>}}.

idstring
fromImportboolean
deleteCommentFieldInfoListarray<object>
uiIdstring
businessKeystring
internalSeqNointeger (int32)
get_overrideCreateUserstring
get_overrideCreateUserNamestring
get_overrideUpdateUserstring
get_overrideUpdateUserNamestring
get_overrideCreatedOnstring (date-time)
get_overrideUpdatedOnstring (date-time)
get_overrideStatusstring
refNostring
domainIdstring
hubDomainIdstring
isForReferenceboolean
versioninteger (int32)
statusstring
docStatusstring
editingStatusstring
createUserstring
createUserNamestring
updateUserstring
updateUserNamestring
createdOnstring (date-time)
updatedOnstring (date-time)
integrationSourcestring
integrationStatusstring
integrationNotestring
isCpmInitializedboolean
isLatestboolean
namestring
descriptionstring
navigationstring
typeLevelinteger (int32)
typeLevelNamestring
totalLevelinteger (int32)
businessRefNostring
linkedPcLevelinteger (int32)
hclTypeobject
idstring
refNostring
versioninteger (int32)
namestring
typestring
levelsListarray<object>12 fields
parentHclNodeobject
idstring
codestring
namestring
lineagestring
fullLineagestring
fullLineageNamestring
disabledboolean
notAvailableboolean
dataListTypeNamestring
refNostring
duidstring
businessRefNostring
hclIdstring
dynamicModelMapobject
hclNodesListarray<object>
idstring
codestring
namestring
lineagestring
fullLineagestring
fullLineageNamestring
disabledboolean
notAvailableboolean
dataListTypeNamestring
refNostring
duidstring
businessRefNostring
hclIdstring
dynamicModelMapobject
json
{
  "id": "string",
  "fromImport": false,
  "deleteCommentFieldInfoList": [
    {
      "uiId": "string",
      "businessKey": "string",
      "internalSeqNo": 0
    }
  ],
  "get_overrideCreateUser": "string",
  "get_overrideCreateUserName": "string",
  "get_overrideUpdateUser": "string",
  "get_overrideUpdateUserName": "string",
  "get_overrideCreatedOn": "2025-01-01T00:00:00Z",
  "get_overrideUpdatedOn": "2025-01-01T00:00:00Z",
  "get_overrideStatus": "string",
  "refNo": "string",
  "domainId": "string"
}

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