ids_properties structure¶
Interface Data Structure properties. This element identifies the node above as an IDS
ids_properties/commentSTR_0D¶Any comment describing the content of this IDS
Any comment describing the content of this IDS
ids_properties/nameSTR_0D¶User-defined name for this IDS occurrence
User-defined name for this IDS occurrence
New in version >3.39.0.
ids_properties/homogeneous_timeINT_0D¶This node must be filled (with 0, 1, or 2) for the IDS to be […]
This node must be filled (with 0, 1, or 2) for the IDS to be valid. If 1, the time of this IDS is homogeneous, i.e. the time values for this IDS are stored in the time node just below the root of this IDS. If 0, the time values are stored in the various time fields at lower levels in the tree. In the case only constant or static nodes are filled within the IDS, homogeneous_time must be set to 2
ids_properties/occurrence_typestructure¶Type of data contained in this occurrence
Type of data contained in this occurrence
This is an identifier. See occurrence_type_identifier for the available options.
New in version >3.39.0.
ids_properties/providerSTR_0D¶Name of the person in charge of producing this data
Name of the person in charge of producing this data
ids_properties/creation_dateSTR_0D¶Date at which this data has been produced
Date at which this data has been produced
ids_properties/version_putstructure¶Version of the access layer package used to PUT this IDS
Version of the access layer package used to PUT this IDS
ids_properties/version_put/data_dictionarySTR_0D¶Version of Data Dictionary used to PUT this IDS
Version of Data Dictionary used to PUT this IDS
ids_properties/provenancestructure¶Provenance information about this IDS
Provenance information about this IDS
New in version 3.34.0: lifecycle status alpha
ids_properties/provenance/node(i1)AoS¶Set of IDS nodes for which the provenance is given. […]
Set of IDS nodes for which the provenance is given. The provenance information applies to the whole structure below the IDS node. For documenting provenance information for the whole IDS, set the size of this array of structure to 1 and leave the child “path” node empty
Maximum occurrences (MDS+ backend only): 20
1 |
|
ids_properties/provenance/node(i1)/pathSTR_0D¶Path of the node within the IDS, following the syntax given in […]
Path of the node within the IDS, following the syntax given in the link below. If empty, means the provenance information applies to the whole IDS.
ids_properties/provenance/node(i1)/reference(i2)AoS¶List of references used to populate or calculate this node, identified […]
List of references used to populate or calculate this node, identified as explained below. In case the node is the result of of a calculation / data processing, the reference is an input to the process described in the “code” structure at the root of the IDS. The reference can be an IDS (identified by a URI or a persitent identifier, see syntax in the link below) or non-IDS data imported directly from an non-IMAS database (identified by the command used to import the reference, or the persistent identifier of the data reference). Often data are obtained by a chain of processes, however only the last process input are recorded here. The full chain of provenance has then to be reconstructed recursively from the provenance information contained in the data references.
Click here for further documentation.
Maximum occurrences (MDS+ backend only): 10
1 |
|
New in version >3.41.0.
ids_properties/provenance/node(i1)/reference(i2)/timestampSTR_0D¶Date and time (UTC) at which the reference was created, expressed […]
Date and time (UTC) at which the reference was created, expressed in a human readable form (ISO 8601) : the format of the string shall be : YYYY-MM-DDTHH:MM:SSZ. Example : 2020-07-24T14:19:00Z
ids_properties/pluginsstructure¶Information about the plugins used to write/read this IDS. […]
Information about the plugins used to write/read this IDS. This structure is filled automatically by the Access Layer at GET/PUT time, no need to fill it via a user program.
New in version 3.39.0: lifecycle status alpha
New in version >3.38.1.
ids_properties/plugins/node(i1)AoS¶Set of IDS nodes for which a plugin has been applied
Set of IDS nodes for which a plugin has been applied
Maximum occurrences (MDS+ backend only): 20
1 |
|
ids_properties/plugins/node(i1)/pathSTR_0D¶Path of the node within the IDS, following the syntax given in […]
Path of the node within the IDS, following the syntax given in the link below. If empty, means the plugin applies to the whole IDS.
ids_properties/plugins/node(i1)/put_operation(i2)AoS¶Plugins used to PUT a node (potentially, multiple plugins can […]
Plugins used to PUT a node (potentially, multiple plugins can be applied, if so they are listed by order of application)
Maximum occurrences (MDS+ backend only): 10
1 |
|
ids_properties/plugins/node(i1)/put_operation(i2)/nameSTR_0D¶Name of software used
Name of software used
ids_properties/plugins/node(i1)/put_operation(i2)/descriptionSTR_0D¶Short description of the software (type, purpose)
Short description of the software (type, purpose)
New in version >3.38.1.
ids_properties/plugins/node(i1)/put_operation(i2)/commitSTR_0D¶Unique commit reference of software
Unique commit reference of software
ids_properties/plugins/node(i1)/put_operation(i2)/versionSTR_0D¶Unique version (tag) of software
Unique version (tag) of software
ids_properties/plugins/node(i1)/put_operation(i2)/repositorySTR_0D¶URL of software repository
URL of software repository
ids_properties/plugins/node(i1)/put_operation(i2)/parametersSTR_0D¶List of the code specific parameters in XML format
List of the code specific parameters in XML format
ids_properties/plugins/node(i1)/put_operation(i2)/library(i3)AoS¶List of external libraries used by the code that has produced […]
List of external libraries used by the code that has produced this IDS
Maximum occurrences (MDS+ backend only): 10
1 |
|
ids_properties/plugins/node(i1)/put_operation(i2)/library(i3)/nameSTR_0D¶Name of software
Name of software
ids_properties/plugins/node(i1)/put_operation(i2)/library(i3)/descriptionSTR_0D¶Short description of the software (type, purpose)
Short description of the software (type, purpose)
New in version >3.38.1.
ids_properties/plugins/node(i1)/put_operation(i2)/library(i3)/commitSTR_0D¶Unique commit reference of software
Unique commit reference of software
ids_properties/plugins/node(i1)/put_operation(i2)/library(i3)/versionSTR_0D¶Unique version (tag) of software
Unique version (tag) of software
ids_properties/plugins/node(i1)/readback(i2)AoS¶Plugins to be used to read back a node (potentially, multiple […]
Plugins to be used to read back a node (potentially, multiple plugins can be applied, listed in reverse order of application)
Maximum occurrences (MDS+ backend only): 10
1 |
|
ids_properties/plugins/node(i1)/readback(i2)/descriptionSTR_0D¶Short description of the software (type, purpose)
Short description of the software (type, purpose)
New in version >3.38.1.
ids_properties/plugins/node(i1)/readback(i2)/commitSTR_0D¶Unique commit reference of software
Unique commit reference of software
ids_properties/plugins/node(i1)/readback(i2)/versionSTR_0D¶Unique version (tag) of software
Unique version (tag) of software
ids_properties/plugins/node(i1)/readback(i2)/repositorySTR_0D¶URL of software repository
URL of software repository
ids_properties/plugins/node(i1)/readback(i2)/parametersSTR_0D¶List of the code specific parameters in XML format
List of the code specific parameters in XML format
ids_properties/plugins/node(i1)/readback(i2)/library(i3)AoS¶List of external libraries used by the code that has produced […]
List of external libraries used by the code that has produced this IDS
Maximum occurrences (MDS+ backend only): 10
1 |
|
ids_properties/plugins/node(i1)/readback(i2)/library(i3)/nameSTR_0D¶Name of software
Name of software
ids_properties/plugins/node(i1)/readback(i2)/library(i3)/descriptionSTR_0D¶Short description of the software (type, purpose)
Short description of the software (type, purpose)
New in version >3.38.1.
ids_properties/plugins/node(i1)/readback(i2)/library(i3)/commitSTR_0D¶Unique commit reference of software
Unique commit reference of software
ids_properties/plugins/node(i1)/readback(i2)/library(i3)/versionSTR_0D¶Unique version (tag) of software
Unique version (tag) of software
ids_properties/plugins/node(i1)/get_operation(i2)AoS¶Plugins actually used to read back a node (potentially, multiple […]
Plugins actually used to read back a node (potentially, multiple plugins can be applied, listed in reverse order of application). This information is filled by the plugin infrastructure during the GET operation.
Maximum occurrences (MDS+ backend only): 10
1 |
|
ids_properties/plugins/node(i1)/get_operation(i2)/nameSTR_0D¶Name of software used
Name of software used
ids_properties/plugins/node(i1)/get_operation(i2)/descriptionSTR_0D¶Short description of the software (type, purpose)
Short description of the software (type, purpose)
New in version >3.38.1.
ids_properties/plugins/node(i1)/get_operation(i2)/commitSTR_0D¶Unique commit reference of software
Unique commit reference of software
ids_properties/plugins/node(i1)/get_operation(i2)/versionSTR_0D¶Unique version (tag) of software
Unique version (tag) of software
ids_properties/plugins/node(i1)/get_operation(i2)/repositorySTR_0D¶URL of software repository
URL of software repository
ids_properties/plugins/node(i1)/get_operation(i2)/parametersSTR_0D¶List of the code specific parameters in XML format
List of the code specific parameters in XML format
ids_properties/plugins/node(i1)/get_operation(i2)/library(i3)AoS¶List of external libraries used by the code that has produced […]
List of external libraries used by the code that has produced this IDS
Maximum occurrences (MDS+ backend only): 10
1 |
|
ids_properties/plugins/node(i1)/get_operation(i2)/library(i3)/nameSTR_0D¶Name of software
Name of software
ids_properties/plugins/node(i1)/get_operation(i2)/library(i3)/descriptionSTR_0D¶Short description of the software (type, purpose)
Short description of the software (type, purpose)
New in version >3.38.1.
ids_properties/plugins/node(i1)/get_operation(i2)/library(i3)/commitSTR_0D¶Unique commit reference of software
Unique commit reference of software
ids_properties/plugins/node(i1)/get_operation(i2)/library(i3)/versionSTR_0D¶Unique version (tag) of software
Unique version (tag) of software
ids_properties/plugins/infrastructure_putstructure¶Plugin infrastructure used to PUT the data
Plugin infrastructure used to PUT the data
ids_properties/plugins/infrastructure_put/descriptionSTR_0D¶Short description of the software (type, purpose)
Short description of the software (type, purpose)
New in version >3.38.1.
ids_properties/plugins/infrastructure_put/commitSTR_0D¶Unique commit reference of software
Unique commit reference of software
ids_properties/plugins/infrastructure_getstructure¶Plugin infrastructure used to GET the data
Plugin infrastructure used to GET the data
ids_properties/plugins/infrastructure_get/descriptionSTR_0D¶Short description of the software (type, purpose)
Short description of the software (type, purpose)
New in version >3.38.1.
ids_properties/plugins/infrastructure_get/commitSTR_0D¶Unique commit reference of software
Unique commit reference of software