/api/codelists/name/{name} (Get latest version of codelist)

Get latest version of codelist

GET/api/codelists/name/{name}

Use it in a workflow

Add a step and choose the TradeBeyond connector.
Pick the /api/codelists/name/{name} (Get latest version of codelist) action (under CodelistController).
Fill in the fields below, then reference the result from later steps as {{apiCodelistsNameNameGetLatestVersionOfCodelist.response.data}}.

Request

Path parameters

namestringrequired

Response

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

refNostring

versioninteger (int32)

namestring

descriptionstring

referenceDataListarray<object>

revisioninteger (int32)

entityVersioninteger (int32)

domainIdstring

conditionstring

hubDomainIdstring

isForReferenceboolean

internalSeqNointeger (int32)

seqNointeger (int32)

codestring

namestring

disabledboolean

refNostring

businessRefNostring

parentIdstring

customFieldsobject1 fields

effectiveFromstring (date-time)

effectiveTostring (date-time)

categoryobject

codestringrequired

namestring

versioninteger (int32)

json

{
  "refNo": "string",
  "version": 0,
  "name": "string",
  "description": "string",
  "referenceDataList": [
    {
      "revision": 0,
      "entityVersion": 0,
      "domainId": "string",
      "condition": "string",
      "hubDomainId": "string",
      "isForReference": false,
      "internalSeqNo": 0,
      "seqNo": 0,
      "code": "string",
      "name": "string",
      "disabled": false,
      "refNo": "string"
    }
  ],
  "category": {
    "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?