FieldConfiguration DTO v9

Fields supported by Coresuite Cloud.

Field Name Type Required Constraint Reference Description
arrayElementType String Optional length >= 1 & length <= 255 If the field is an array, this is the type of elements.
classificationLevel ClassificationLevel Required Allowed values { RESTRICTED, CONFIDENTIAL, INTERNAL, PUBLIC } Security classification level.
columnNames List<String> Optional DB column names.
code String Required length >= 1 & length <= 255 Code of the field.
enumType String Optional length >= 1 & length <= 255 If the field is an enum, this is the type of enum.
enumValues List<String> Optional If the field is a static enum, those are the values.
fieldName String Required length >= 1 & length <= 255 Name of the field.
fieldType FieldType Required Allowed values { ARRAY, BINARY, BOOLEAN, DATE, DATETIME, DECIMAL, ENUM, EMAIL, ID, INTEGER, LOCATION, MAP, MONETARY, PROPERTYVALUE, STRING, TEXT, TIME, UDFVALUE, UNKNOWN, URL } Type of the field (e.g. boolean, number, string).
logicalCode String Optional length >= 1 & length <= 255 In case this is a part of some logical field.
mapKeyType String Optional length >= 1 & length <= 255 If the field is a map, this is the type of map.
mapValueType String Optional length >= 1 & length <= 255 If the field is a map, this is the type of map.
maxLength Integer Optional Minimum length of the field value.
minLength Integer Optional Maximum length of the field value.
objectName String Required length >= 1 & length <= 255 Nice location of this field.
objectType DomainObjectModel Required Allowed values { PRICELIST, PAYMENTTERM, PAYMENTTYPE, CURRENCY, COMPANYINFO, BUSINESSPARTNERGROUP, SHIPPINGTYPE, EMPLOYEEPOSITION, EMPLOYEEDEPARTMENT, EMPLOYEEBRANCH, SERVICECALLSTATUS, SERVICECALLTYPE, SERVICECALLPROBLEMTYPE, SERVICECALLORIGIN, UDFMETAGROUP, UDFMETA, ITEMGROUP, ITEMTYPE, WAREHOUSE, ITEMCATEGORY, TIMEPROJECT, WORKTIMETASK, REPORTDATA, COUNTRY, STATE, COUNTY, GROUP, OBJECTGROUP, PERSONRESERVATIONTYPE, PERSON, PERSONSTATUS, LOCATION, BUSINESSPARTNER, ADDRESS, CONTACT, BUSINESSPARTNER_REFERENCES, ITEM, ITEMPRICELISTASSIGNMENT, ITEMWAREHOUSELEVEL, SERIALNUMBER, EQUIPMENT, SALESORDER, SALESORDERITEM, PURCHASEORDERITEM, PURCHASEORDER, SALESQUOTATIONITEM, SALESQUOTATION, ALERT, ACTIVITY, ATTACHMENT, DEFECT, INCIDENT, SERVICECALL, SERVICEASSIGNMENT, OBJECTRATING, SIGNATURE, TIMETASK, TIMESUBTASK, TIMEEFFORT, SYNCOBJECTKPI, WORKTIME, ITEMPROPOSAL, EXPENSETYPE, TAX, EXPENSE, MILEAGETYPE, BATCH, BATCHQUANTITY, MATERIAL, MILEAGE, APPROVAL, PRODUCTIONORDER, CHECKLISTCATEGORY, CHECKLISTTEMPLATE, CHECKLISTINSTANCE, BUSINESSPROCESSSTEPDEFINITION, BUSINESSPROCESSSTEPASSIGNMENT, SERVICECHECKOUT, INVOICEITEM, INVOICE, CREDITNOTEITEM, CREDITNOTE, COMPANYSETTINGS, USERSETTINGS, PERSONRESERVATION, USERSYNCCONFIRMATION, SERVICEERRORCODEITEM, SERVICEERRORCODE, ACTIVITYSUBTYPE, ACTIVITYTOPIC, USAGE, SERVICECONTRACT, PROPERTYMETA, SERVICECONTRACTEQUIPMENT, BLANKETORDER, DOCUMENTDISCOUNT, GENERICORDER, ITEMRETURNREASON, LOCATIONNUMBERSERIES, TRANSPORTCOST, VISITORREPORT, INVENTORY, STOCKTRANSFER, DOCUMENTDRAFTITEM, DOCUMENTDRAFT, COMPETITOR, COMPETITORPRODUCT, INDUSTRY, INFORMATIONSOURCE, LEVELOFINTEREST, CATEGORY, REASON, SALESSTAGE, SALESOPPORTUNITY, ENUMERATION, CHECKLISTASSIGNMENT, ERPERROR, RESERVEDMATERIAL, BRANCH, CHECKIN, ACTIVITYFEEDBACK, ACTIVITYCOMPOSEDCODE, ACTIVITYCODE, REPORTTEMPLATE, SERVICEASSIGNMENTSTATUS, SERVICEASSIGNMENTSTATUSDEFINITION, COMMENT, SEQUENCE, FILE, FILEREVISION, FILEREF, ATTRIBUTE, ATTRIBUTEVALUE, ACTIVITYTEMPLATE, SERVICESUITECONFIG, CHECKLISTINSTANCEELEMENT, EQUIPMENTSUBTYPE, TRANSLATION, FIELDCONFIGURATION, SCREENCONFIGURATION, SYNCOBJECTCHANGELOG, CONFIGURATION, FILTER, CUSTOMRULE, TAG, SKILL, REQUIREMENT, FUNCTION, DASHBOARD, WIDGET, PLUGIN, ERPSYNCFILTER, PROJECT, PROJECTPHASE, NOWPLUGIN, NOWPLUGININSTANCE, NOWPLUGININSTANCESET, NOWSHORTURL, WORKTIMEPATTERN, PERSONWORKTIMEPATTERN, UDOMETA, UDOVALUE, ICON, CROWDPERSON, CROWDASSIGNMENT, CROWDBUSINESSPARTNER, CROWDEXECUTIONRECORD, UNIFIEDPERSON, NOTIFICATION, NOWKPI, CROWDSKILL, ACTIVITYPRICE, EMAILTEMPLATE, TEAM, NOWPLUGINVERSION, CHECKLISTTAG, QUERY, CONSENT, TEAMTIMEFRAME, SHIFT, SHIFTTECHNICIAN, SERVICEWORKFLOW, CHECKLISTVARIABLE, CASE, CASEACTION, CASEORIGIN, CASETYPE, PROJECTMEMBERTIMEFRAME, REPORTINSTANCE, PROJECTSHIFT, UNKNOWN } Location of this field.
objectVersion Integer Required DTO's version.
referencedFieldName String Optional length >= 1 & length <= 255 If the field is a foreign key, but not by id, this is the name of that field in referenced object.
referencedObjectType DomainObjectModel Optional Allowed values { PRICELIST, PAYMENTTERM, PAYMENTTYPE, CURRENCY, COMPANYINFO, BUSINESSPARTNERGROUP, SHIPPINGTYPE, EMPLOYEEPOSITION, EMPLOYEEDEPARTMENT, EMPLOYEEBRANCH, SERVICECALLSTATUS, SERVICECALLTYPE, SERVICECALLPROBLEMTYPE, SERVICECALLORIGIN, UDFMETAGROUP, UDFMETA, ITEMGROUP, ITEMTYPE, WAREHOUSE, ITEMCATEGORY, TIMEPROJECT, WORKTIMETASK, REPORTDATA, COUNTRY, STATE, COUNTY, GROUP, OBJECTGROUP, PERSONRESERVATIONTYPE, PERSON, PERSONSTATUS, LOCATION, BUSINESSPARTNER, ADDRESS, CONTACT, BUSINESSPARTNER_REFERENCES, ITEM, ITEMPRICELISTASSIGNMENT, ITEMWAREHOUSELEVEL, SERIALNUMBER, EQUIPMENT, SALESORDER, SALESORDERITEM, PURCHASEORDERITEM, PURCHASEORDER, SALESQUOTATIONITEM, SALESQUOTATION, ALERT, ACTIVITY, ATTACHMENT, DEFECT, INCIDENT, SERVICECALL, SERVICEASSIGNMENT, OBJECTRATING, SIGNATURE, TIMETASK, TIMESUBTASK, TIMEEFFORT, SYNCOBJECTKPI, WORKTIME, ITEMPROPOSAL, EXPENSETYPE, TAX, EXPENSE, MILEAGETYPE, BATCH, BATCHQUANTITY, MATERIAL, MILEAGE, APPROVAL, PRODUCTIONORDER, CHECKLISTCATEGORY, CHECKLISTTEMPLATE, CHECKLISTINSTANCE, BUSINESSPROCESSSTEPDEFINITION, BUSINESSPROCESSSTEPASSIGNMENT, SERVICECHECKOUT, INVOICEITEM, INVOICE, CREDITNOTEITEM, CREDITNOTE, COMPANYSETTINGS, USERSETTINGS, PERSONRESERVATION, USERSYNCCONFIRMATION, SERVICEERRORCODEITEM, SERVICEERRORCODE, ACTIVITYSUBTYPE, ACTIVITYTOPIC, USAGE, SERVICECONTRACT, PROPERTYMETA, SERVICECONTRACTEQUIPMENT, BLANKETORDER, DOCUMENTDISCOUNT, GENERICORDER, ITEMRETURNREASON, LOCATIONNUMBERSERIES, TRANSPORTCOST, VISITORREPORT, INVENTORY, STOCKTRANSFER, DOCUMENTDRAFTITEM, DOCUMENTDRAFT, COMPETITOR, COMPETITORPRODUCT, INDUSTRY, INFORMATIONSOURCE, LEVELOFINTEREST, CATEGORY, REASON, SALESSTAGE, SALESOPPORTUNITY, ENUMERATION, CHECKLISTASSIGNMENT, ERPERROR, RESERVEDMATERIAL, BRANCH, CHECKIN, ACTIVITYFEEDBACK, ACTIVITYCOMPOSEDCODE, ACTIVITYCODE, REPORTTEMPLATE, SERVICEASSIGNMENTSTATUS, SERVICEASSIGNMENTSTATUSDEFINITION, COMMENT, SEQUENCE, FILE, FILEREVISION, FILEREF, ATTRIBUTE, ATTRIBUTEVALUE, ACTIVITYTEMPLATE, SERVICESUITECONFIG, CHECKLISTINSTANCEELEMENT, EQUIPMENTSUBTYPE, TRANSLATION, FIELDCONFIGURATION, SCREENCONFIGURATION, SYNCOBJECTCHANGELOG, CONFIGURATION, FILTER, CUSTOMRULE, TAG, SKILL, REQUIREMENT, FUNCTION, DASHBOARD, WIDGET, PLUGIN, ERPSYNCFILTER, PROJECT, PROJECTPHASE, NOWPLUGIN, NOWPLUGININSTANCE, NOWPLUGININSTANCESET, NOWSHORTURL, WORKTIMEPATTERN, PERSONWORKTIMEPATTERN, UDOMETA, UDOVALUE, ICON, CROWDPERSON, CROWDASSIGNMENT, CROWDBUSINESSPARTNER, CROWDEXECUTIONRECORD, UNIFIEDPERSON, NOTIFICATION, NOWKPI, CROWDSKILL, ACTIVITYPRICE, EMAILTEMPLATE, TEAM, NOWPLUGINVERSION, CHECKLISTTAG, QUERY, CONSENT, TEAMTIMEFRAME, SHIFT, SHIFTTECHNICIAN, SERVICEWORKFLOW, CHECKLISTVARIABLE, CASE, CASEACTION, CASEORIGIN, CASETYPE, PROJECTMEMBERTIMEFRAME, REPORTINSTANCE, PROJECTSHIFT, UNKNOWN } If the field is a foreign key, this is the referenced object type.
required Boolean Required Is the field value required?
unique Boolean Required Is the field value unique?