Data Structure
The ADAPT data model consists of multiple entities.
DataView
DataView is a dataset created from a connected DataSource or uploaded files needed for creating reports.
dataViewID
string
Yes
Unique identifier for the data view.
author
string
Yes
Name or ID of the user who created the data view.
name
string
Yes
Display name of the data view.
valid
boolean
No
Indicates if the data view is valid.
created
number
Yes
Timestamp when the data view was created.
updated
number
No
Timestamp of the last update.
status
string
Yes
Current status of the data view.
description
string
Yes
Detailed description of the data view.
dataViewType
string
Yes
Type of data source (file, database) for data view.
data
DBDataViewDataCollection
Yes
The actual data stored in the view.
lastPull
string
Yes
Timestamp or indicator of the last data pull.
pulledBy
string
Yes
User or process that last pulled the data.
DBDataViewDataCollection
DBDataViewDataCollection is a definition of the data access patterns and properties used to populate a DataView from either a set of files or a database connection.
id
string
Yes
Unique identifier for the data collection.
dataSource
string
No
Source of the data (if available).
fields
DataViewField[]
Yes
An array of fields included in the data collection.
files
Array<Object>
Yes
A list of files related to the data collection.
files.id
string
Yes
Unique identifier for each file.
files.database
Object
No
Database-related information if available.
files.database.query
string
Yes
Query used to fetch data from the database.
files.dataParse
DataParseDefinition
No
Parsing details for processing data.
files.location
string
Yes
Location where the file is stored.
files.errors
any
No
Any errors associated with the file.
DataSource
DataSource defines the connection to a database so that data can be pulled directly from it for creating data views.
dataSourceID
string
Yes
Unique identifier for the data source.
name
string
Yes
Name of the data source.
source
string
Yes
Origin of the data source.
description
string
No
Description of the data source.
source
string
No
Origin of the data.
fileSpec
string
No
File specification details.
Note: Not currently used but can be in the future to support a data file as a data source.
author
string
No
Author of the data source.
updated
number
No
Timestamp when the data source was updated.
sourceType
DataSourceType
No
Type of the data source.
metadata
Record<string, any>
No
Additional metadata as key-value pairs.
path
string
Yes
File path of the data source.
fileType
DataSourceFileType
No
Type of the data file.
Note: Not currently used but can be in the future to support a data file as a data source.
dataFiles
string[]
No
List of related data files.
lastPull
number
No
Timestamp of the last data pull.
validFile
boolean
No
Indicates whether the file is valid.
fileErrors
Array<Object>
No
List of file errors.
fileErrors.error
string
Yes
Error message.
fileErrors.header
string
Yes
Header where the error occurred.
fileErrors.id
string
Yes
Identifier for the error.
connectionInfo
string | DataSourceConnectionInfo
Yes
Connection details or secret manager ID.
Report
Report defines the information to render a report, including the DataView used for the data and the template used for the report.
reportID
string
Yes
Unique identifier for the report.
name
string
Yes
Name of the report.
lang
string
No
Language of the report.
updated
string
Yes
Timestamp of the last update.
template
IRenderedTemplate
Yes
Rendered template associated with the report.
author
string
Yes
Creator of the report.
approval
string
Yes
Approval status of the report.
published
string
Yes
Timestamp of when the report was published.
version
string
Yes
Version number of the report.
dataView
string
Yes
Data view associated with the report.
slug
string
No
URL-friendly identifier for the report.
visibility
ReportVisibility
Yes
Defines who can access the report (e.g., external, internal).
IRenderedTemplate
IRenderedTemplate defines the structure of a report that is rendered in the ADAPT Viewer application and consists of the charts, descriptions, and data elements that make up a report. Report templates can have multiple pages and sections.
id
string
Yes
Unique identifier for the rendered template.
title
StringTemplate
Yes
Title of the template, which can be a string or a templated value.
description
StringTemplate
Yes
Description of the template, which can be a string or a templated value.
sections
ISection[]
No
List of sections within the template, loaded asynchronously.
pages
ITemplatePage[]
No
List of pages in the template, loaded asynchronously.
Last updated