Skip to content

DataObject

The definition of a data set, file, or table. A Data Object can be the source or target in a DataObjectMapping. A Data Object can also represent a query (a view, script, or procedure) by setting QueryCode and optionally QueryLanguage.

Source of truth: DataObject.cs

JSON nameTypeDescription
idstringAn optional identifier for the Data Object.
namestringThe mandatory name of the Data Object.
dataConnectionDataConnectionThe connection information associated with the Data Object.
dataItemsarray of DataItemThe collection of Data Items associated with this Data Object.
queryCodestringWhen set, the Data Object represents a query (view, script, or procedure) rather than a stored table.
queryLanguagestringThe language that QueryCode is written in (e.g. SQL).
businessKeyDefinitionsarray of BusinessKeyDefinitionThe definition of the Business Key(s) for the Data Object. Capturing the business key definition here supports defining a series of business keys against the source Data Object and reusing these across different Data Object Mappings.
relationshipsarray of RelationshipRelationships to other Data Objects (parent/child, foreign keys, lookups, etc.).
classificationsarray of DataClassificationFree-form and optional classification for the Data Object.
extensionsarray of ExtensionThe collection of extension Key/Value pairs.
templateMappingsarray of TemplateMappingThe collection of template references that apply to this Data Object.
notesstringFree-format notes.