UdfMeta DTO v15

Meta data for all available udf values in the system. This meta data contains a link to the objectType which this information belongs to and different other settings to let the system configure the behaviour on the clients.

Field Name Type Required Constraint Reference Description
defaultValue String Optional length >= 1 & length <= 255 Default value which is displayed to the user while entering the value for the udf.
description String Optional length >= 1 & length <= 255 Displayed label of the udf.
descriptionTranslations KeyValueHolderList Optional a field that contains the translation of the UDF name
mandatory Boolean Optional Indicator if the user has to fill this udf while creating an object of the specified object type.
multipleValues Boolean Optional a field that specifies if the UDF allows multiple values
name String Required length >= 1 & length <= 255 Internal name of the udf.
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 } Object type to which this meta data belong.
parentUdf Identifier Optional UdfMeta : 10, 12, 13, 14, 15, 16, 17, 18 Contact of the business partner.
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 } In case UDF is a reference to another object, this is that object type.
selectionKeyValues KeyValueHolderList Optional Selection keys and values which let the user only choose from this predefined set of values like a combo box.
type CloudDataType Optional Allowed values { STRING, INT, FLOAT, DATE, TIME, DATETIME, PERCENTAGE, UNIT, MONETARYAMOUNT, SELECTIONLIST, SELECTIONLISTWITHFREETEXT, BOOLEAN, UUID } The exact cloud data type which should be used to prompt the user for. For detailed specification about the formats see CloudDataType.
validationRegex String Optional length >= 1 & length <= 255 This is a field for specifying the validation regex (regular expression) for the possible values
valueLength Integer Optional This is the length of the value field, the following restrictions apply: - If this field is a string, than this is the maximum length - If this field is a number, this is the maximum length of number character