Get Template Test Detail

  • Published on Jan 6, 2026
  • 7 minute(s) read
Prev Next
Get
/api/v1/Authoring/projects/{projectId}/template-tests/{testId}

Returns information about a specified template test

Security
API Key: x-val-api-token
Header parameter namex-val-api-token

API key needed to access endpoints. Each Validatar user can manage their own set of API keys.

Path parameters
projectId
integer (int32) Required

Project containing the test

testId
integer (int32) Required

Template test to retrieve

Responses
200

OK

Expand All
object
detail
object (Configuration.Api.Models.v1.TemplateTestDetail)
testId
integer (int32) | null

The template test's ID

templateName
string | null

The template test's template name

templateDescription
string | null

The template test's template description

dataSourceId
integer (int32) | null

The template test's data source ID

testLevelId
integer (int32) | null

The template test's test level ID

testGenSourceId
integer (int32) | null

The template test's test gen source ID

testGenTypeId
integer (int32) | null

The template test's test gen type ID

childTestName
string | null

The template test's child test name

childTestDescription
string | null

The template test's child test description

childFolderId
integer (int32) | null

The template test's child folder ID

childFolderRelativePath
string | null

The template test's child folder relative path

leftDataSet
object (Configuration.Api.Models.v1.DataSetTemplateTest)
testDataSetTypeId
integer (int32) | null

The data set's type

dataSource
string | null

The data set's data source

metaLinks
string | null

The data set's meta links

configurationJson
string | null

The data set's configuration, written in JSON

rightDataSet
object (Configuration.Api.Models.v1.DataSetTemplateTest)
testDataSetTypeId
integer (int32) | null

The data set's type

dataSource
string | null

The data set's data source

metaLinks
string | null

The data set's meta links

configurationJson
string | null

The data set's configuration, written in JSON

valueSuccessConditionType
string | null

The template test's value success condition type

valueSuccessTolerance
string | null

The template test's value success tolerance

overallSuccessConditionType
string | null

The template test's overall success condition type

overallSuccessTolerance
string | null

The template test's overall success tolerance

resultsAreOrdered
string | null

Whether the template test's results are ordered

onlyKeepFailures
string | null

Whether the template test's results only keep failures

abortAfterFailures
string | null

Whether the template test aborts after a certain amount of failures

abortFailureCount
string | null

Number of failures before the template test aborts

abortAfterRows
string | null

Whether the template test aborts after a certain amount of rows

abortRowCount
string | null

Number of rows before the template test aborts

purgeResults
string | null

Whether the template test will purge results

purgeResultsAfterDays
string | null

Number of days after execution when results are purged

transferLabels
boolean

Set to transfer labels

versionId
integer (int32) | null

The template test's version ID

variables
Array of object (Configuration.Api.Models.v1.TemplateTestVariable) | null

The template test's variables

object
referenceKey
string | null

The variable's reference key

type
string
Valid values[ "Schema", "Table", "Column", "Other", "Boolean", "Numeric" ]
defaultValue
string | null

The variable's default value

objectFilters
Array of object (Configuration.Api.Models.v1.TemplateTestMetaObjectFilter) | null

The template test's object filters

object
id
integer (int32) | null

The template test filter's ID

fieldKey
string | null

The template test filter's field key

operatorId
integer (int32) | null

The template test filter's operator ID

value
string | null

The template test filter's value

templateTestImportFileId
integer (int32) | null

The template test's import file ID

metaObjectQuery
object (Configuration.Api.Models.v1.MetaObjectQuery)
dataSourceId
integer (int32) | null

The query's data source ID

script
string | null

The query's script

dataSources
Array of object (Configuration.Api.Models.v1.TestDataSource) | null

The template test's data sources

object
hasMetadata
boolean

Whether the data source has metadata

canViewMetadata
boolean

Whether the user can view metadata

isActive
boolean

Whether the data source is active

id
integer (int32)

The object's ID

name
string | null

The object's name

dataSetTypeCombinations
Array of object (Configuration.Api.Models.v1.DataSetTypeCombination) | null

The template test's data set type combinations

object
targetSetTypes
Array

List of target set types

OneOf
Configuration.Api.Models.v1.DataSetType
object (Configuration.Api.Models.v1.DataSetType)
isScalar
boolean

Whether the data set type is scalar

requiresDataSource
boolean

Whether the data set type requires a data source

requiresMetadata
boolean

Whether the data set type requires metadata

id
integer (int32)

The object's ID

name
string | null

The object's name

Configuration.Api.Models.v1.DataSetTypeCombination
isScalar
boolean

Whether the data set type is scalar

requiresDataSource
boolean

Whether the data set type requires a data source

requiresMetadata
boolean

Whether the data set type requires metadata

id
integer (int32)

The object's ID

name
string | null

The object's name

leftDataSource
object (Configuration.Api.Models.v1.TestDataSource)
hasMetadata
boolean

Whether the data source has metadata

canViewMetadata
boolean

Whether the user can view metadata

isActive
boolean

Whether the data source is active

id
integer (int32)

The object's ID

name
string | null

The object's name

rightDataSource
object (Configuration.Api.Models.v1.TestDataSource)
hasMetadata
boolean

Whether the data source has metadata

canViewMetadata
boolean

Whether the user can view metadata

isActive
boolean

Whether the data source is active

id
integer (int32)

The object's ID

name
string | null

The object's name

defaultAbortFailureCount
integer (int32)

The template test's default number of failures allowed before aborting

variableTypes
Array of object (Configuration.Api.Models.v1.Common.KeyValue) | null

The template test's variable types

object
id
integer (int32)

The object's ID

name
string | null

The object's name

profileAggregates
Array of object (Configuration.Api.Models.v1.Common.KeyValue) | null

The template test's profile aggregates

object
id
integer (int32)

The object's ID

name
string | null

The object's name

profileWindows
Array of object (Configuration.Api.Models.v1.Common.KeyValue) | null

The template test's profile windows

object
id
integer (int32)

The object's ID

name
string | null

The object's name

profileDefinitions
Array of object (Configuration.Api.Models.v1.ProfileDefinition) | null

The template test's profile definitions

object
dataSourceId
integer (int32) | null

The profile definition's data source ID

engineIds
Array of integer | null

The profile definition's engine IDs

integer (int32)
levelId
integer (int32)

The profile definition's level ID

referenceKey
string | null

The profile definition's reference key

id
integer (int32)

The object's ID

name
string | null

The object's name

metaReferences
Array of object (Configuration.Api.Models.v1.AvailableReference) | null

The template test's meta references

object
referenceKey
string | null

The reference's key

levelId
integer (int32)

The reference's level ID

metaQueryReferences
Array of object (Configuration.Api.Models.v1.AvailableReference) | null

The template test's meta query references

object
referenceKey
string | null

The reference's key

levelId
integer (int32)

The reference's level ID

folders
Array of object (Configuration.Api.Models.v1.FolderItem) | null

The template test's folders

object
id
integer (int32)

The folder item's ID

name
string | null

The tree item's name

icon
string
Valid values[ "Folder", "Home", "Project", "TestRoot", "JobRoot", "ResultRoot", "ScheduleRoot", "ConnectionRoot", "Settings", "User", "Group", "Tools", "Import", "Export", "License", "Configuration", "StandardTest", "MaterializedTest", "Job", "Connection", "DbEngine", "DataSourceGroup", "DataSource", "DataProfileDef", "DataTable", "DataColumn", "DataTableTestFolder", "Activity", "DataProfileSet", "TemplateTest", "Labels", "UserToken", "DataQualityCatalog", "Explorer", "Report", "DataSchema", "CustomField" ]
items
Array of object (Configuration.Api.Models.v1.FolderItem) | null

The tree item's items

object Recursive
selectedFolder
object (Configuration.Api.Models.v1.FolderItem)
id
integer (int32)

The folder item's ID

name
string | null

The tree item's name

icon
string
Valid values[ "Folder", "Home", "Project", "TestRoot", "JobRoot", "ResultRoot", "ScheduleRoot", "ConnectionRoot", "Settings", "User", "Group", "Tools", "Import", "Export", "License", "Configuration", "StandardTest", "MaterializedTest", "Job", "Connection", "DbEngine", "DataSourceGroup", "DataSource", "DataProfileDef", "DataTable", "DataColumn", "DataTableTestFolder", "Activity", "DataProfileSet", "TemplateTest", "Labels", "UserToken", "DataQualityCatalog", "Explorer", "Report", "DataSchema", "CustomField" ]
items
Array of object (Configuration.Api.Models.v1.FolderItem) | null

The tree item's items

object Recursive
hasTemplateTestLicense
boolean

Whether the user has a license that allows for template tests

hasMaterializedTests
boolean

Whether the template test has materialized tests

objectFilterFields
Array of object (Configuration.Api.Models.v1.MetaObjectFilterField) | null

The template test'sobject filter fields

object
fieldKey
string | null

The filter field's key

fieldName
string | null

The filter field's name

operators
Array of object (Configuration.Api.Models.v1.Common.KeyValue) | null

The filter field's operators

object
id
integer (int32)

The object's ID

name
string | null

The object's name

metaDataTypes
Array of object (Configuration.Api.Models.v1.Common.KeyValue) | null

The template test's meta data types

object
id
integer (int32)

The object's ID

name
string | null

The object's name

metaTableTypes
Array of object (Configuration.Api.Models.v1.Common.KeyValue) | null

The template test's meta table types

object
id
integer (int32)

The object's ID

name
string | null

The object's name

versionInfo
object (Configuration.Api.Models.v1.VersionInfo)
versionId
integer (int32)

The version info's version ID

versionNumber
integer (int32)

The version info's version number

latestVersionName
string | null

The version info's latest version name

latestVersionNumber
integer (int32)

The version info's latest version number

createdInfo
string | null

The version info's creation info

versions
Array of object (Configuration.Api.Models.v1.TestVersion) | null

The version info's list of test versions

object
number
integer (int32)

The version's number

name
string | null

The version's name

creationDate
string | null

The version's creation date

creationTime
string | null

The version's creation time

creator
string | null

The version's creator

labels
Array of string | null

The version's assigned labels

string
importFile
object (Configuration.Api.Models.v1.ImportFileInfo)
fileId
integer (int32)

The import file's ID

dateCreated
string (date-time)

The import file's date of creation

recordCount
integer (int32)

The import file's record count

summary
object (Configuration.Api.Models.v1.TemplateTestSummary)
asOfDate
string (date-time) | null

Date the template test summary is based off of

metrics
Array of object (Configuration.Api.Models.v1.Metric) | null

The template test summary's metrics

object
name
string | null

The metric's name

value
integer (int32)

The metric's value

assignedLabels
Array of object (Configuration.Api.Models.v1.AssignedLabel) | null

The template test's assigned labels

object
id
integer (int32)

The ID of the label assignment

labelId
integer (int32)

The ID of the label

labelName
string | null

The name of the label

isLocked
boolean

Whether the label is locked

isTestAuthor
boolean

Whether the user is a test author

defaultStringEvaluationOperatorId
integer (int32)

The template test's default string evaluation operator ID

defaultStringEvaluationResultId
integer (int32)

The template test's default string evaluation result ID

defaultStringCaseSensitive
boolean

Whether the template test's default string is case sensitive

404

Not Found

object
error
string | null