RetailHardHat Developer docs

REST API documentation

Risk Factors

Risk assessment factor definitions

Supported operations

This resource provides field metadata only. No dedicated CRUD endpoint is advertised.

Field reference

Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
categoryIduuidOptionalcategory Id

Related resource: riskCategories

categorystringOptionalcategory
namestringRequiredname
descriptionstringOptionaldescription
factorTypeenumOptionalfactor Type

Values: numeric, percentage, dropdown, boolean

weightnumberOptionalweight
optionsjsonOptionaloptions
isRequiredbooleanOptionalis Required
displayOrdernumberOptionaldisplay Order
isActivebooleanOptionalis Active
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)