younifyd
Menu

/api/codelists (The saveAndConfirm action of CodelistBook)

The saveAndConfirm action of CodelistBook

POST/api/codelists

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/codelists (The saveAndConfirm action of CodelistBook) action (under CodelistController).
  3. Fill in the fields below, then reference the result from later steps as {{apiCodelistsTheSaveandconfirmActionOfCodelistbook.response.data}}.

Request

Query parameters

approvalTemplateIdstring

Request body

Enter the body as JSON in the step's Body 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
  }
}

Response

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