Get Template by ID

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

Get Template by ID

Path Parameters:

Parameter	Type	Mandatory	Description	Example
templateId	string	true	null

This API requires SETTINGS_GET_TEMPLATE permission(s).

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.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.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.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

Response body

object

displayName

string

required

length between 1 and 64

name

string

required

length between 1 and 36

description

string

length between 1 and 2147483647

ownerOrganizationId

uuid

analyticsDbConfiguration

object

name

string

uuid

entityTypeName

string

removable

boolean

creationTime

date-time

required

A UTC date-time in the ISO-8601 format

lastModifiedTime

date-time

required

A UTC date-time in the ISO-8601 format

parentTemplate

object

uuid

displayName

string

name

string

parentTemplateId

uuid

deprecated

customAttributes

array of objects

customAttributes

object

displayName

string

required

length between 1 and 36

phi

boolean

referenceConfiguration

object

linkConfiguration

object

name

string

required

length between 1 and 36

type

string

required

LABEL PARAGRAPH INTEGER DECIMAL BOOLEAN SINGLE_SELECT MULTI_SELECT ADDRESS NAME PHONE EMAIL DATE_TIME DATE REFERENCE TIMEZONE LOCALE FILE IMAGE LINK WAVEFORM

validation

object

numericMetaData

object

analyticsDbConfiguration

object

uuid

required

selectableValues

array of objects

selectableValues

object

name

string

required

displayName

string

required

uuid

400Bad Request

401Code : TOKEN_NOT_VALID, Details: []

403Code : ACCESS_DENIED, Details: []

404Code : TEMPLATE_NOT_FOUND, Details: [templateId]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []