Update Template

put

https://example.com/settings/v1/templates/{templateId}

Update Template

Important notice: This is a full update API (PUT), all existing attributes must be specified in the request body. Attributes that are not specified will be deleted from the updated record (receive a NULL value).

Performs full update, the values will be replaced with values that are specified in the request

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

Request Body Parameters:

Parameter	Type	Mandatory	Description	Example
displayName	string	true
name	string	true	Pattern:[a-zA-Z]\w*
description	string	false
ownerOrganizationId	string	false
analyticsDbConfiguration	object	false
analyticsDbConfiguration.name	string	false
forceUpdate	boolean	false	Deprecated. Use the 'force' query parameter instead.
customAttributes	array	true	Custom attributes definitions for this template. Empty list means no custom attributes.
customAttributes[index]	array	false	Custom attributes definitions for this template. Empty list means no custom attributes.
customAttributes[index].displayName	string	true(*)
customAttributes[index].phi	boolean	false
customAttributes[index].referenceConfiguration	object	false
customAttributes[index].referenceConfiguration.uniquely	boolean	false
customAttributes[index].referenceConfiguration.referencedSideAttributeName	string	false
customAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName	string	false
customAttributes[index].referenceConfiguration.validTemplatesToReference	array	false
customAttributes[index].referenceConfiguration.entityType	string	true(*)
customAttributes[index].linkConfiguration	object	false
customAttributes[index].linkConfiguration.entityTypeName	string	true(*)
customAttributes[index].linkConfiguration.templateId	string	true(*)
customAttributes[index].linkConfiguration.attributeId	string	true(*)
customAttributes[index].name	string	true(*)	Pattern:[a-zA-Z]\w*
customAttributes[index].type	string	true(*)	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].validation	object	false
customAttributes[index].validation.mandatory	boolean	true(*)
customAttributes[index].validation.unique	boolean	false	Default:false	false
customAttributes[index].validation.defaultValue	object	false
customAttributes[index].validation.min	number	false
customAttributes[index].validation.max	number	false
customAttributes[index].validation.regex	string	false
customAttributes[index].numericMetaData	object	false
customAttributes[index].numericMetaData.units	string	false
customAttributes[index].numericMetaData.upperRange	number	false
customAttributes[index].numericMetaData.lowerRange	number	false
customAttributes[index].numericMetaData.subType	string	false	Values:INTEGER,DECIMAL
customAttributes[index].analyticsDbConfiguration	object	false
customAttributes[index].analyticsDbConfiguration.name	string	false
customAttributes[index].id	string	false
customAttributes[index].selectableValues	array	false
customAttributes[index].selectableValues[index]	array	false
customAttributes[index].selectableValues[index].name	string	true(*)	Pattern:[a-zA-Z]\w*
customAttributes[index].selectableValues[index].displayName	string	true(*)
customAttributes[index].selectableValues[index].id	string	false
customAttributes[index].category	string	true(*)
builtInAttributes	array	true	Built-in attributes definitions for this template. Empty list is allowed.
builtInAttributes[index]	array	false	Built-in attributes definitions for this template. Empty list is allowed.
builtInAttributes[index].id	string	true(*)
builtInAttributes[index].displayName	string	true(*)
builtInAttributes[index].phi	boolean	false
builtInAttributes[index].referenceConfiguration	object	false
builtInAttributes[index].referenceConfiguration.uniquely	boolean	false
builtInAttributes[index].referenceConfiguration.referencedSideAttributeName	string	false
builtInAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName	string	false
builtInAttributes[index].referenceConfiguration.validTemplatesToReference	array	false
builtInAttributes[index].referenceConfiguration.entityType	string	true(*)
builtInAttributes[index].linkConfiguration	object	false
builtInAttributes[index].linkConfiguration.entityTypeName	string	true(*)
builtInAttributes[index].linkConfiguration.templateId	string	true(*)
builtInAttributes[index].linkConfiguration.attributeId	string	true(*)
builtInAttributes[index].validation	object	false
builtInAttributes[index].validation.mandatory	boolean	true(*)
builtInAttributes[index].validation.unique	boolean	false	Default:false	false
builtInAttributes[index].validation.defaultValue	object	false
builtInAttributes[index].validation.min	number	false
builtInAttributes[index].validation.max	number	false
builtInAttributes[index].validation.regex	string	false
builtInAttributes[index].numericMetaData	object	false
builtInAttributes[index].numericMetaData.units	string	false
builtInAttributes[index].numericMetaData.upperRange	number	false
builtInAttributes[index].numericMetaData.lowerRange	number	false
builtInAttributes[index].numericMetaData.subType	string	false	Values:INTEGER,DECIMAL
templateAttributes	array	true	Template-level attributes definitions. Empty list is allowed.
templateAttributes[index]	array	false	Template-level attributes definitions. Empty list is allowed.
templateAttributes[index].id	string	true(*)
templateAttributes[index].displayName	string	true(*)
templateAttributes[index].phi	boolean	false
templateAttributes[index].referenceConfiguration	object	false
templateAttributes[index].referenceConfiguration.uniquely	boolean	false
templateAttributes[index].referenceConfiguration.referencedSideAttributeName	string	false
templateAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName	string	false
templateAttributes[index].referenceConfiguration.validTemplatesToReference	array	false
templateAttributes[index].referenceConfiguration.entityType	string	true(*)
templateAttributes[index].linkConfiguration	object	false
templateAttributes[index].linkConfiguration.entityTypeName	string	true(*)
templateAttributes[index].linkConfiguration.templateId	string	true(*)
templateAttributes[index].linkConfiguration.attributeId	string	true(*)
templateAttributes[index].value	object	false
templateAttributes[index].organizationSelectionConfiguration	object	false
templateAttributes[index].organizationSelectionConfiguration.selected	array	false
templateAttributes[index].organizationSelectionConfiguration.selected[index]	array	false
templateAttributes[index].organizationSelectionConfiguration.selected[index].id	string	true(*)
templateAttributes[index].organizationSelectionConfiguration.all	boolean	false
parentTemplateId	string	false	The parent template id if this template inherits from another template.	123e4567-e89b-12d3-a456-426614174000
Path Parameters:

Parameter	Type	Mandatory	Description	Example
templateId	string	true	null
Query Parameters:

Parameter	Type	Mandatory	Description	Example
force	boolean	false	Sometimes 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. If 'force' is not provided fallback is the 'forceUpdate' value inside 'templateRequest'	true

This API requires SETTINGS_UPDATE_TEMPLATE permission(s).

Path Params

templateId

uuid

required

Query Params

force

boolean

Sometimes 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. If 'force' is not provided fallback is the 'forceUpdate' value inside 'templateRequest'

Body Params

displayName

string

required

length between 1 and 64

name

string

required

length between 1 and 36

[a-zA-Z]\w*

description

string

length between 1 and 2147483647

ownerOrganizationId

uuid

analyticsDbConfiguration

object

forceUpdate

boolean

deprecated

Deprecated. Use the 'force' query parameter instead.

customAttributes

array of objects

required

Custom attributes definitions for this template. Empty list means no custom attributes.

customAttributes*

builtInAttributes

array of objects

required

Built-in attributes definitions for this template. Empty list is allowed.

builtInAttributes*

templateAttributes

array of objects

required

Template-level attributes definitions. Empty list is allowed.

templateAttributes*

parentTemplateId

uuid

The parent template id if this template inherits from another template.

Responses

Parameter	Type	Description	Example
displayName	string
name	string	Pattern:[a-zA-Z]\w*
description	string
ownerOrganizationId	string
analyticsDbConfiguration	object
analyticsDbConfiguration.name	string
id	string
entityTypeName	string
removable	boolean
creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
parentTemplate	object
parentTemplate.id	string
parentTemplate.displayName	string
parentTemplate.name	string
parentTemplateId	string
customAttributes	array
customAttributes[index]	array
customAttributes[index].displayName	string
customAttributes[index].phi	boolean
customAttributes[index].referenceConfiguration	object
customAttributes[index].referenceConfiguration.uniquely	boolean
customAttributes[index].referenceConfiguration.referencedSideAttributeName	string
customAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName	string
customAttributes[index].referenceConfiguration.validTemplatesToReference	array
customAttributes[index].referenceConfiguration.entityType	string
customAttributes[index].linkConfiguration	object
customAttributes[index].linkConfiguration.entityTypeName	string
customAttributes[index].linkConfiguration.templateId	string
customAttributes[index].linkConfiguration.attributeId	string
customAttributes[index].name	string	Pattern:[a-zA-Z]\w*
customAttributes[index].type	string	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].validation	object
customAttributes[index].validation.mandatory	boolean
customAttributes[index].validation.unique	boolean	Default:false	false
customAttributes[index].validation.defaultValue	object
customAttributes[index].validation.min	number
customAttributes[index].validation.max	number
customAttributes[index].validation.regex	string
customAttributes[index].numericMetaData	object
customAttributes[index].numericMetaData.units	string
customAttributes[index].numericMetaData.upperRange	number
customAttributes[index].numericMetaData.lowerRange	number
customAttributes[index].numericMetaData.subType	string	Values:INTEGER,DECIMAL
customAttributes[index].analyticsDbConfiguration	object
customAttributes[index].analyticsDbConfiguration.name	string
customAttributes[index].id	string
customAttributes[index].selectableValues	array
customAttributes[index].selectableValues[index]	array
customAttributes[index].selectableValues[index].name	string	Pattern:[a-zA-Z]\w*
customAttributes[index].selectableValues[index].displayName	string
customAttributes[index].selectableValues[index].id	string
customAttributes[index].category	object
customAttributes[index].category.name	string
customAttributes[index].category.displayName	string
customAttributes[index].basePath	string
customAttributes[index].typeEnum	string	Values:LABEL,PARAGRAPH,INTEGER,DECIMAL,BOOLEAN,SINGLE_SELECT,MULTI_SELECT,ADDRESS,NAME,PHONE,EMAIL,DATE_TIME,DATE,REFERENCE,TIMEZONE,LOCALE,FILE,IMAGE,LINK,WAVEFORM
builtInAttributes	array
builtInAttributes[index]	array
builtInAttributes[index].name	string
builtInAttributes[index].basePath	string
builtInAttributes[index].id	string
builtInAttributes[index].displayName	string
builtInAttributes[index].phi	boolean
builtInAttributes[index].referenceConfiguration	object
builtInAttributes[index].referenceConfiguration.uniquely	boolean
builtInAttributes[index].referenceConfiguration.referencedSideAttributeName	string
builtInAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName	string
builtInAttributes[index].referenceConfiguration.validTemplatesToReference	array
builtInAttributes[index].referenceConfiguration.entityType	string
builtInAttributes[index].linkConfiguration	object
builtInAttributes[index].linkConfiguration.entityTypeName	string
builtInAttributes[index].linkConfiguration.templateId	string
builtInAttributes[index].linkConfiguration.attributeId	string
builtInAttributes[index].validation	object
builtInAttributes[index].validation.mandatory	boolean
builtInAttributes[index].validation.unique	boolean	Default:false	false
builtInAttributes[index].validation.defaultValue	object
builtInAttributes[index].validation.min	number
builtInAttributes[index].validation.max	number
builtInAttributes[index].validation.regex	string
builtInAttributes[index].numericMetaData	object
builtInAttributes[index].numericMetaData.units	string
builtInAttributes[index].numericMetaData.upperRange	number
builtInAttributes[index].numericMetaData.lowerRange	number
builtInAttributes[index].numericMetaData.subType	string	Values:INTEGER,DECIMAL
builtInAttributes[index].type	string	Values:LABEL,PARAGRAPH,INTEGER,DECIMAL,BOOLEAN,SINGLE_SELECT,MULTI_SELECT,ADDRESS,NAME,PHONE,EMAIL,DATE_TIME,DATE,REFERENCE,TIMEZONE,LOCALE,FILE,IMAGE,LINK,WAVEFORM
builtInAttributes[index].category	object
builtInAttributes[index].category.name	string
builtInAttributes[index].category.displayName	string
builtInAttributes[index].validationMetadata	object
builtInAttributes[index].validationMetadata.mandatoryReadOnly	boolean
builtInAttributes[index].validationMetadata.systemMandatory	boolean
builtInAttributes[index].validationMetadata.phiReadOnly	boolean
builtInAttributes[index].selectableValues	array
builtInAttributes[index].selectableValues[index]	array
builtInAttributes[index].selectableValues[index].name	string	Pattern:[a-zA-Z]\w*
builtInAttributes[index].selectableValues[index].displayName	string
builtInAttributes[index].readOnly	boolean
builtInAttributes[index].analyticsDbConfiguration	object
builtInAttributes[index].analyticsDbConfiguration.name	string
builtInAttributes[index].typeEnum	string	Values:LABEL,PARAGRAPH,INTEGER,DECIMAL,BOOLEAN,SINGLE_SELECT,MULTI_SELECT,ADDRESS,NAME,PHONE,EMAIL,DATE_TIME,DATE,REFERENCE,TIMEZONE,LOCALE,FILE,IMAGE,LINK,WAVEFORM
templateAttributes	array
templateAttributes[index]	array
templateAttributes[index].name	string
templateAttributes[index].basePath	string
templateAttributes[index].id	string
templateAttributes[index].displayName	string
templateAttributes[index].phi	boolean
templateAttributes[index].referenceConfiguration	object
templateAttributes[index].referenceConfiguration.uniquely	boolean
templateAttributes[index].referenceConfiguration.referencedSideAttributeName	string
templateAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName	string
templateAttributes[index].referenceConfiguration.validTemplatesToReference	array
templateAttributes[index].referenceConfiguration.entityType	string
templateAttributes[index].linkConfiguration	object
templateAttributes[index].linkConfiguration.entityTypeName	string
templateAttributes[index].linkConfiguration.templateId	string
templateAttributes[index].linkConfiguration.attributeId	string
templateAttributes[index].value	object
templateAttributes[index].type	string	Values:LABEL,PARAGRAPH,INTEGER,DECIMAL,BOOLEAN,SINGLE_SELECT,MULTI_SELECT,ADDRESS,NAME,PHONE,EMAIL,DATE_TIME,DATE,REFERENCE,TIMEZONE,LOCALE,FILE,IMAGE,LINK,WAVEFORM
templateAttributes[index].category	object
templateAttributes[index].category.name	string
templateAttributes[index].category.displayName	string
templateAttributes[index].selectableValues	array
templateAttributes[index].selectableValues[index]	array
templateAttributes[index].selectableValues[index].name	string	Pattern:[a-zA-Z]\w*
templateAttributes[index].selectableValues[index].displayName	string
templateAttributes[index].validation	object
templateAttributes[index].validation.mandatory	boolean
templateAttributes[index].validation.unique	boolean	Default:false	false
templateAttributes[index].validation.defaultValue	object
templateAttributes[index].validation.min	number
templateAttributes[index].validation.max	number
templateAttributes[index].validation.regex	string
templateAttributes[index].numericMetaData	object
templateAttributes[index].numericMetaData.units	string
templateAttributes[index].numericMetaData.upperRange	number
templateAttributes[index].numericMetaData.lowerRange	number
templateAttributes[index].numericMetaData.subType	string	Values:INTEGER,DECIMAL
templateAttributes[index].organizationSelection	object
templateAttributes[index].organizationSelection.allowed	boolean
templateAttributes[index].organizationSelection.configuration	object
templateAttributes[index].organizationSelection.configuration.selected	array
templateAttributes[index].organizationSelection.configuration.selected[index]	array
templateAttributes[index].organizationSelection.configuration.selected[index].id	string
templateAttributes[index].organizationSelection.configuration.all	boolean
templateAttributes[index].typeEnum	string	Values:LABEL,PARAGRAPH,INTEGER,DECIMAL,BOOLEAN,SINGLE_SELECT,MULTI_SELECT,ADDRESS,NAME,PHONE,EMAIL,DATE_TIME,DATE,REFERENCE,TIMEZONE,LOCALE,FILE,IMAGE,LINK,WAVEFORM

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Code : TOKEN_NOT_VALID, Details: []

409Code : TEMPLATE_ANALYTICS_DB_NAME_ALREADY_EXISTS, Details: [] Code : ANALYTICS_DB_DATA_SYNCHRONIZATION_IS_ENABLED, Details: []

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []