- Home
- Documentation
- Configuration Documents
- ConfigDoc
Config - ConfigDoc
The ConfigDoc document is a configuration document that sits at the highest document level.
Each of the child documents in a Configuration Document Collection reference the ConfigDoc document.
The ConfigDoc document provides an overview of the type and structure of data contained in the child documents,
it also acts as a basic meta data container to describe the data stored by this configuration.
| Field |
Data Type |
Required |
Default |
Description |
| subConfigDocs |
SubConfigDoc[] |
Yes |
- |
An array of SubConfigDocs that store the metadata of data associated with the current ConfigDoc. |
| timeSpanDocs |
TimeSpanDoc[] |
No |
- |
An array of documents describing the segmented time spans of a configuration. Each document contains the properties and a data values for an individual time span instance. |
| startTime |
Int64 |
Yes |
- |
A 64-bit Long timestamp specifying start time of the data that this configuration holds. If this configuration holds no data, then the value represents the last modified time of the source document. The timestamp represents the number of nanoseconds since the reference time of midnight, 1st January 1970. |
| endTime |
Int64 |
No |
- |
A 64-bit Long timestamp specifying end time of the data that this configuration holds. If this configuration holds no data, then the value represents the last modified time of the source document. The timestamp represents the number of nanoseconds since the reference time of midnight, 1st January 1970 |
| timeOffset |
Int64 |
No |
- |
A 64-bit Long value specifying the time offset in nanoseconds that is applied to all timestamp fields within the collection of child documents in the Configuration Document Collection. This value can be either positive or negative |
| description |
String |
No |
- |
A free form string description of the data that this configuration holds. |
| name |
String |
Yes |
- |
A free form string name for the data that this configuration holds. |
| source |
String |
No |
- |
The source file name (including extension) for the data held by the configuration. |
| state |
Fixed String |
Yes |
Unknown |
A fixed type field that describes the last known state of the configuration document. Valied options are: Importing, Live, Historic, Invalid, Merging, Deleted. |
| sourceType |
Fixed String |
Yes |
Data |
A fixed value describing the source type of the primary data held by this configuration. Valid options are: Configuration, Data, Experiment, Simulation, Run, Period, Session, Event, Day, Month, Year, Lap |
| tags |
TagDoc[] |
No |
- |
An array of key/value pair free form string values. Used to store meta data related to the data stored by this configuration. |
| configDefsDocIds |
String[] |
No |
- |
An array of unique identifiers (id) of the ConfigDefinitionsDoc document specific to the type of definition doc referenced by the configDoc. Used for informational purposes to enable fast retrieval of all the definitions used in a single Configuration Document Collection |
| Field |
Data Type |
Required |
Default |
Description |