AGSi Standard / Data

agsiData

Object description

The agsiData object is a container for all of the data for a file/data set. It is required in all cases where properties and/or parameters are provided. There is only one agsiData object per root object. All other objects in the Data group are embedded within agsiData.

The parent object of agsiData is root

agsiData contains the following embedded child objects:

• agsiDataParameterSet
• agsiDataPropertySet
• agsiDataCase
• agsiDataCode

agsiData has the following attributes:

• dataSetID
• description
• codeDictionary
• documentSetID
• agsiDataParameterSet
• agsiDataPropertySet
• agsiDataCase
• agsiDataCode
• remarks

Attributes

dataSetID

Identifier, possibly a UUID. This is optional and is not referenced anywhere else in the schema, but it is beneficial to include this to help with data control and integrity.
Type: string (identifier)
Example: 40b785d0-547c-41c5-9b36-3cd31126ecb0

description

Similar usage to dataSetID but intended to be a more verbose description.
Type: string
Example: My Project Name GIR interpreted data

codeDictionary

URI link to the dictionary/vocabulary used for the code list. Use of the AGSi code list is recommended, but it can be changed to an alternate list, e.g. lists published by other agencies (UK or overseas) or major projects/clients. If this is populated, then use of agsiDataCode is optional.
Type: string (uri)
Condition: Required if agsiDataCode not used
Example: https://ags-data-format-wg.gitlab.io/AGSi_Documentation/Codes_List/

documentSetID

Reference to documents relevant to the properties and parameters described herein, such as a GIR, AGS (factual) data and/or GDR
Type: string (reference to documentSetID of agsProjectDocumentSet object)
Condition: Recommended
Example: PackageXGIRGDR

agsiDataParameterSet

Array of embedded agsiDataParameterSet object(s)
Type: array (agsiDataParameterSet object(s))

agsiDataPropertySet

Array of embedded agsiDataPropertySet object(s)
Type: array (agsiDataPropertySet object(s))

agsiDataCase

Array of embedded agsiDataCase object(s)
Type: array (agsiDataCase object(s))

agsiDataCode

Array of embedded agsiDataCode object(s)
Type: array (agsiDataCode object(s))
Condition: Required if codeDictionary not used

remarks

Additional remarks, if required
Type: string
Example: Some remarks if required