User GuideAPI Reference
ProductUse CasesResource CenterFAQAbout UsBook a DemoSign Up - It's Free
API Reference

Create a new Template

Create a new Template

(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.

Request Body Parameters:

ParameterTypeMandatoryDescriptionExample
displayNamestringtrue
namestringtruePattern:[a-zA-Z]\w*
descriptionstringfalse
ownerOrganizationIdstringfalse
customAttributesarrayfalse
customAttributes[index]arrayfalse
customAttributes[index].displayNamestringtrue(*)
customAttributes[index].phibooleanfalse
customAttributes[index].referenceConfigurationobjectfalse
customAttributes[index].referenceConfiguration.uniquelybooleanfalse
customAttributes[index].referenceConfiguration.referencedSideAttributeNamestringfalse
customAttributes[index].referenceConfiguration.referencedSideAttributeDisplayNamestringfalse
customAttributes[index].referenceConfiguration.validTemplatesToReferencearrayfalse
customAttributes[index].referenceConfiguration.entityTypestringtrue(*)
customAttributes[index].linkConfigurationobjectfalse
customAttributes[index].linkConfiguration.entityTypeNamestringtrue(*)
customAttributes[index].linkConfiguration.templateIdstringtrue(*)
customAttributes[index].linkConfiguration.attributeIdstringtrue(*)
customAttributes[index].namestringtrue(*)Pattern:[a-zA-Z]\w*
customAttributes[index].typestringtrue(*)Values:LABEL,PARAGRAPH,INTEGER,DECIMAL,BOOLEAN,SINGLE_SELECT,MULTI_SELECT,ADDRESS,NAME,PHONE,EMAIL,DATE_TIME,DATE,REFERENCE,TIMEZONE,LOCALE,FILE,IMAGE,LINK,WAVEFORM
customAttributes[index].validationobjectfalse
customAttributes[index].validation.mandatorybooleantrue(*)
customAttributes[index].validation.defaultValueobjectfalse
customAttributes[index].validation.minnumberfalse
customAttributes[index].validation.maxnumberfalse
customAttributes[index].validation.regexstringfalse
customAttributes[index].numericMetaDataobjectfalse
customAttributes[index].numericMetaData.unitsstringfalse
customAttributes[index].numericMetaData.upperRangenumberfalse
customAttributes[index].numericMetaData.lowerRangenumberfalse
customAttributes[index].numericMetaData.subTypestringfalseValues:INTEGER,DECIMAL
customAttributes[index].selectableValuesarrayfalse
customAttributes[index].selectableValues[index]arrayfalse
customAttributes[index].selectableValues[index].namestringtrue(*)Pattern:[a-zA-Z]\w*
customAttributes[index].selectableValues[index].displayNamestringtrue(*)
customAttributes[index].categorystringtrue(*)
builtInAttributesarrayfalse
builtInAttributes[index]arrayfalse
builtInAttributes[index].namestringtrue(*)
builtInAttributes[index].basePathstringfalse
builtInAttributes[index].displayNamestringtrue(*)
builtInAttributes[index].phibooleanfalse
builtInAttributes[index].referenceConfigurationobjectfalse
builtInAttributes[index].referenceConfiguration.uniquelybooleanfalse
builtInAttributes[index].referenceConfiguration.referencedSideAttributeNamestringfalse
builtInAttributes[index].referenceConfiguration.referencedSideAttributeDisplayNamestringfalse
builtInAttributes[index].referenceConfiguration.validTemplatesToReferencearrayfalse
builtInAttributes[index].referenceConfiguration.entityTypestringtrue(*)
builtInAttributes[index].linkConfigurationobjectfalse
builtInAttributes[index].linkConfiguration.entityTypeNamestringtrue(*)
builtInAttributes[index].linkConfiguration.templateIdstringtrue(*)
builtInAttributes[index].linkConfiguration.attributeIdstringtrue(*)
builtInAttributes[index].validationobjectfalse
builtInAttributes[index].validation.mandatorybooleantrue(*)
builtInAttributes[index].validation.defaultValueobjectfalse
builtInAttributes[index].validation.minnumberfalse
builtInAttributes[index].validation.maxnumberfalse
builtInAttributes[index].validation.regexstringfalse
builtInAttributes[index].numericMetaDataobjectfalse
builtInAttributes[index].numericMetaData.unitsstringfalse
builtInAttributes[index].numericMetaData.upperRangenumberfalse
builtInAttributes[index].numericMetaData.lowerRangenumberfalse
builtInAttributes[index].numericMetaData.subTypestringfalseValues:INTEGER,DECIMAL
templateAttributesarrayfalse
templateAttributes[index]arrayfalse
templateAttributes[index].namestringtrue(*)
templateAttributes[index].basePathstringfalse
templateAttributes[index].displayNamestringtrue(*)
templateAttributes[index].phibooleanfalse
templateAttributes[index].referenceConfigurationobjectfalse
templateAttributes[index].referenceConfiguration.uniquelybooleanfalse
templateAttributes[index].referenceConfiguration.referencedSideAttributeNamestringfalse
templateAttributes[index].referenceConfiguration.referencedSideAttributeDisplayNamestringfalse
templateAttributes[index].referenceConfiguration.validTemplatesToReferencearrayfalse
templateAttributes[index].referenceConfiguration.entityTypestringtrue(*)
templateAttributes[index].linkConfigurationobjectfalse
templateAttributes[index].linkConfiguration.entityTypeNamestringtrue(*)
templateAttributes[index].linkConfiguration.templateIdstringtrue(*)
templateAttributes[index].linkConfiguration.attributeIdstringtrue(*)
templateAttributes[index].valueobjectfalse
templateAttributes[index].organizationSelectionConfigurationobjectfalse
templateAttributes[index].organizationSelectionConfiguration.selectedarrayfalse
templateAttributes[index].organizationSelectionConfiguration.selected[index]arrayfalse
templateAttributes[index].organizationSelectionConfiguration.selected[index].idstringtrue(*)
templateAttributes[index].organizationSelectionConfiguration.allbooleanfalse
entityTypestringtrue
parentTemplateIdstringfalse

Query Parameters:

ParameterTypeMandatoryDescriptionExample
forcebooleanfalseSometimes modifying the system's templates can cause side effects to other components. The 'force' flag indicates whether or not to force the template changes even if those side effects were to occur. For example: changing templates will cause Analytics DB to exit syncing data mode.true

This API requires SETTINGS_CREATE_TEMPLATE permission(s).

Language
Authorization
Bearer
JWT
Click Try It! to start a request and see the response here!