/api/vendors/getDefaultChecklistTemplate/{applyTo}/{moduleSection} (Get default Checklist Template)

Get default Checklist Template

POST/api/vendors/getDefaultChecklistTemplate/{applyTo}/{moduleSection}

Use it in a workflow

Add a step and choose the TradeBeyond connector.
Pick the /api/vendors/getDefaultChecklistTemplate/{applyTo}/{moduleSection} (Get default Checklist Template) action (under VendorController).
Fill in the fields below, then reference the result from later steps as {{apiVendorsGetdefaultchecklisttemplateApplytoModulesectionGetDefaultChecklistTemplate.response.data}}.

Request

Path parameters

applyTostringrequired

moduleSectionstringrequired

Request body

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

businessRefNostring

connectionstring

revisioninteger (int32)

entityVersioninteger (int32)

domainIdstring

hubDomainIdstring

isForReferenceboolean

versioninteger (int32)

statusstring

docStatusstring

editingStatusstring

integrationSourcestring

integrationStatusstring

createUserstring

createUserNamestring

updateUserstring

updateUserNamestring

createdOnstring (date-time)

updatedOnstring (date-time)

isLatestboolean

vendorCodestring

referencestring

businessNamestring

shortNamestring

parentGroupstring

remarksstring

address1string

address2string

address3string

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",
  "businessRefNo": "string"
}

Response

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

idstring

refNostring

versioninteger (int32)

namestring

isAllowAddDeleteReqboolean

baseScorenumber

totalMinimumScorenumber

mandatCheckStatusValuestring

auditCategoryobject

codestringrequired

namestring

versioninteger (int32)

scoreCalculationobject

codestringrequired

namestring

versioninteger (int32)

isRequireCapaEntriesboolean

isRequireObservationEntriesboolean

factoryAuditTemplateColumnsListarray<object>

revisioninteger (int32)

entityVersioninteger (int32)

domainIdstring

hubDomainIdstring

isForReferenceboolean

internalSeqNointeger (int32)

lineItemSeqinteger (int32)

duidstring

seqNointeger (int32)

legendstring

labelstring

descriptionstring

isDisabledboolean

isExcludeboolean

isRequiredCAPAboolean

factoryAuditTemplateColumnImpListarray<object>12 fields

isCountInZTFailureboolean

customFieldsobject1 fields

factoryAuditTemplateRequirementsListarray<object>

seqNointeger (int32)

descriptionstring

itemKeyinteger (int32)

isDisabledboolean

isRequired1boolean

isRequired2boolean

isRequired3boolean

isRequired4boolean

isRequired5boolean

isRequired6boolean

isRequired7boolean

isRequired8boolean

isRequired9boolean

isRequired10boolean

isMandatoryboolean

notesInstructionsstring

fieldTypeobject3 fields

defaultValueBookNamestring

defaultValueSlnBookNamestring

defaultValueDropdownobject17 fields

defaultValueImageobject2 fields

defaultValueDatestring (date)

defaultValueDecimalnumber

defaultValueNumberinteger (int32)

defaultValueTextareastring

defaultValueTextstring

defaultValueSelectionValuestring

reviewByValuestring

reviewByListarray<object>3 fields

maximumScoreinteger (int32)

defaultValueSelectionarray<object>3 fields

importanceobject3 fields

factoryAuditTemplateSectionRefstring

factoryAuditTemplateSectionobject12 fields

defaultValueRefstring

defaultValueobject18 fields

isExcludeboolean

customFieldsobject1 fields

factoryAuditTemplateSectionsListarray<object>

seqNointeger (int32)

namestring

parentSectionstring

notesInstructionsstring

isDisabledboolean

isAddDisabledboolean

isDeleteDisabledboolean

isAddAvailableboolean

isCopyAvailableboolean

isDeleteAvailableboolean

isSelectAvailableboolean

customFieldsobject1 fields

factoryAuditTemplateConditionsListarray<object>

actionobject3 fields

fieldTypeobject3 fields

conditionQuestionValuestring

conditionValueBookNamestring

questionValuestring

conditionValuestring

questionListarray<object>9 fields

conditionQuestionListarray<object>9 fields

conditionOptionsListarray<object>4 fields

factAuditTemplImprtanceResultOptionMapobject

factoryAuditTemplateExcludeColumnsMapobject

checklistMandatoryTypeListarray<object>

codestringrequired

namestring

versioninteger (int32)

customFieldsobject

dynamicModelMapobject

json

{
  "id": "string",
  "refNo": "string",
  "version": 0,
  "name": "string",
  "isAllowAddDeleteReq": false,
  "baseScore": 0,
  "totalMinimumScore": 0,
  "mandatCheckStatusValue": "string",
  "auditCategory": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "scoreCalculation": {
    "code": "string",
    "name": "string",
    "version": 0
  },
  "isRequireCapaEntries": false,
  "isRequireObservationEntries": false
}

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

Was this page helpful?