diff --git a/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/README.md b/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/README.md new file mode 100644 index 0000000..f0d0581 --- /dev/null +++ b/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/README.md @@ -0,0 +1,300 @@ +# AAS (Asset Administration Shell) + +This is the sub-namespace reserved for the Asset Administration Shell Metamodel version 3.0 (IDTA-01003-a-3-0). + + +## Introduction + +The Metamodel itself is defined in the 'IDTA-01001-3-0 Specification of the Asset Administration Shell - Part 1: Metamodel'. Only classes, attributes and named entities used in this model are allowed in this sub-namespace. The Metamodel is the core resource for the structure of the Asset Administration Shell and provides the frame for all further specifications. The following entities are defined in the Metamodel but also serve as an example how to use the 'Asset Administration Shell Identifiers' in general. + +## Status: Accepted + +The sub-namespace DataSpecificationTemplates/DataSpecificationIec61360 has been accepted by the Coordination Board. +The identifiers are derived following the grammar as defined in IDTA-01001-3-0. The grammar has been accepted by the Coordination Board + + +// DataSpecificationIec61360 + +## DataSpecificationIec61360 + Data Specification Template for defining Property Descriptions conformant to IEC 61360. + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360) The DataSpecificationIec61360 class as defined in DTA-01003-a-3-0. + +## DataSpecificationIec61360/datatype + + + [ https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/dataType]( https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/dataType) The attribute dataType of the DataSpecificationIec61360 class as defined in DTA-01003-a-3-0. + +## DataSpecificationIec61360/definition + + Definition of the concept in multiple languages + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/definition](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/definition) The attribute definition of the DataSpecificationIec61360 class as defined in DTA-01003-a-3-0. + +## DataSpecificationIec61360/levelType + + Level type of the concept + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/levelType](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/levelType) The attribute levelType of the DataSpecificationIec61360 class as defined in IDTA-01003-a-3-0. + +## DataSpecificationIec61360/preferredName + + Preferred name of the concept + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/preferredName](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/preferredName) The attribute preferredName of the DataSpecificationIec61360 class as defined in IDTA-01003-a-3-0. + +## DataSpecificationIec61360/shortName + + Short name of the concept. + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/shortName](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/shortName) The attribute shortName of the DataSpecificationIec61360 class as defined in IDTA-01003-a-3-0. + +## DataSpecificationIec61360/sourceOfDefinition + + Source of definition of the concept + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/sourceOfDefinition](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/sourceOfDefinition) The attribute sourceOfDefinition of the DataSpecificationIec61360 class as defined in IDTA-01003-a-3-1. + +## DataSpecificationIec61360/symbol + + symbol of the concept + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/symbol](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/symbol) The attribute symbol of the DataSpecificationIec61360 class as defined in IDTA-01003-a-3-0. + +## DataSpecificationIec61360/unit + + unit of the concept + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/unit](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/unit) The attribute unit of the DataSpecificationIec61360 class as defined in IDTA-01003-a-3-0. + +## DataSpecificationIec61360/unitId + + Unique identifier of the unit + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/unitId](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/unitId) The attribute unitId of the DataSpecificationIec61360 class as defined in IDTA-01003-a-3-0. + +## DataSpecificationIec61360/value + + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/value](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/value) The attribute value of the DataSpecificationIec61360 class as defined in IDTA-01003-a-3-0. + + +## DataSpecificationIec61360/valueFormat + + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/valueFormat](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/valueFormat) The attribute valueFormat of the DataSpecificationIec61360 class as defined in IDTA-01003-a-3-0. + + +## DataSpecificationIec61360/valueList + + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/valueList](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataSpecificationIec61360/valueList) The attribute valueList of the DataSpecificationIec61360 class as defined in IDTA-01003-a-3-1. + + + +// Enum DataTypeIec61360 + +## DataTypeIec61360 + Enumeration of all IEC 61360 defined data types. + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360) The DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + +## DataTypeIec61360/BOOLEAN + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/BOOLEAN](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/BOOLEAN) The NamedIndividual BOOLEAN of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + +## DataTypeIec61360/BLOB + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/BLOB](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/BLOB) The NamedIndividual BLOG of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + +## DataTypeIec61360/DATE + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/DATE](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/DATE) The NamedIndividual DATE of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + +## DataTypeIec61360/FILE + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/FILE](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/FILE) The NamedIndividual FILE of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + +## DataTypeIec61360/HTML + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/HTML](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/HTML) The NamedIndividual HTML of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/INTEGER_COUNT + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/INTEGER_COUNT](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/INTEGER_COUNT) The NamedIndividual INTEGER_COUNT of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/INTEGER_CURRENCY + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/INTEGER_CURRENCY](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/INTEGER_CURRENCY) The NamedIndividual INTEGER_CURRENCY of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + +## DataTypeIec61360/INTEGER_MEASURE + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/INTEGER_MEASURE](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/INTEGER_MEASURE) The NamedIndividual INTEGER_MEASURE of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/IRDI + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/IRDI](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/IRDI) The NamedIndividual IRDI of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/IRI + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/IRI](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/IRI) The NamedIndividual IRI of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/RATIONAL + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/RATIONAL](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/RATIONAL) The NamedIndividual RATIONAL of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. +3 + +## DataTypeIec61360/RATIONAL_MEASURE + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/RATIONAL_MEASURE](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/RATIONAL_MEASURE) The NamedIndividual RATIONAL_MEASURE of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/REAL_COUNT + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/REAL_COUNT](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/REAL_COUNT) The NamedIndividual REAL_COUNT of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/REAL_CURRENCY + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/REAL_CURRENCY](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/REAL_CURRENCY) The NamedIndividual REAL_CURRENCY of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/REAL_MEASURE + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/REAL_MEASURE](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/REAL_MEASURE) The NamedIndividual REAL_MEASURE of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/STRING + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/STRING](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/STRING) The NamedIndividual STRING of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/STRING_TRANSLATABLE + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/STRING_TRANSLATABLE](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/STRING_TRANSLATABLE) The NamedIndividual STRING_TRANSLATABLE of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + +## DataTypeIec61360/TIME + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/TIME](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/TIME) The NamedIndividual TIME of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DataTypeIec61360/TIMESTAMP + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/TIMESTAMP](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DataTypeIec61360/TIMESTAMP) The NamedIndividual TIMESTAMP of the DataTypeIec61360 class as defined in IDTA-01003-a-3-1. + + +## DefinitionTypeIec61360 + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/DefinitionTypeIec61360](http://admin-shell.io/ataSpecificationTemplates/DataSpecificationIec61360/3/0/DefinitionTypeIec61360) The DefinitionTypeIec61360 data type as defined in IDTA-01003-a-3-0. + + +// Enum LevelType + +## LevelType + Enumeration of different level types within a DataSpecificationIec61360. Contains Min, Max, Nom, and Typ. + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/LevelType](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/LevelType) The LevelType class as defined in IDTA-01003-a-3-1. + +## LevelType/min + Min according to IEC 61360 as an Identifier scheme for minimal levels. + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/LevelType/MIN](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/LevelType/MIN) The attribute min of the LevelType class as defined in IDTA-01003-a-3-0. + +## LevelType/max + Max according to IEC 61360 as an Identifier scheme for maximal levels. + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/LevelType/max](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/LevelType/MAX) The attribute max of the LevelType class as defined in IDTA-01003-a-3-0. + +## LevelType/nom + nominal according to IEC 61360 as an Identifier scheme for nominal levels. + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/LevelType/nom](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/LevelType/nom) The attribute nom of the LevelType class as defined in IDTA-01003-a-3-0. + +## LevelType/type + TYP according to IEC 61360 as an Identifier scheme for typical levels. + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/LevelType/typ](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/LevelType/typ) The attribute typ of the LevelType class as defined in IDTA-01003-a-3-0. + + +## Data Type PreferredNameTypeIec61360 + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/PreferredNameTypeIec61360](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/PreferredNameTypeIec61360) The PreferredNameTypeIec61360 data type as defined in IDTA-01003-a-3-0. + + +## Data Type ShortNameTypeIec61360 + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ShortNameTypeIec61360](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ShortNameTypeIec61360) The ShortNameTypeIec61360 data type as defined in IDTA-01003-a-3-0. + + +## Data Type ValueFormatTypeIec61360 + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueFormatTypeIec61360](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueFormatTypeIec61360) The ValueFormatTypeIec61360 data type as defined in IDTA-01003-a-3-0. + +// ValueList + +## ValueList + + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueList](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueList) The ValueList class as defined in IDTA-01003-a-3-1. + +## ValueList/valueReferencePairs + + + [ https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueList/valueReferencePairs]( https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueList/valueReferencePairs) The attribute valueReferencePair of the ValueList class as defined in IDTA-01003-a-3-1. + +// ValueReferencePair + +## ValueReferencePair + + + [https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueReferencePair](https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueReferencePair) The ValueReferencePair class as defined in IDTA-01003-a-3-1. + +## ValueReferencePair/value + + + [ https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueReferencePair/value]( https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueReferencePair/value) The attribute value of the ValueReferencePair class as defined in IDTA-01003-a-3-1. + +## ValueReferencePair/valueId + + + [ https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueReferencePair/valueId]( https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueReferencePair/valueId) The attribute valueId of the ValueReferencePair class as defined in IDTA-01003-a-3-1. + + +## Data Type ValueTypeIec61360 + + + [http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueTypeIec61360](http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0/ValueTypeIec61360) The ValueTypeIec61360 data type as defined in IDTA-01003-a-3-0. + + +// Data Type VersionType + +## VersionType + + + [http://admin-shell.io/aas/3/0/VersionType](http://admin-shell.io/aas/3/0/VersionType) The VersionType data type as defined in IDTA-01001-3-0. + + + +## Status: `approved` + diff --git a/aas/3/0/README.md b/aas/3/0/README.md index bbae535..4af353e 100644 --- a/aas/3/0/README.md +++ b/aas/3/0/README.md @@ -1,7 +1,1777 @@ # AAS (Asset Administration Shell) -This is the sub-namespace resevered for the Asset Administration Shell Metamodel version 3.0. +This is the sub-namespace reserved for the Asset Administration Shell Metamodel version 3.0 (IDTA-01001-3-0). -## Status: `suggested` -The sub-namespace AAS 3.0 and its identifiers are currently under development by the subworking group 'Asset Administration Shell'. See the [Candidate Release](./RC01/README.md) for further information. +## Introduction + +The Metamodel itself is defined in the 'IDTA-01001-3-0 Specification of the Asset Administration Shell - Part 1: Metamodel'. Only classes, attributes and named entities used in this model are allowed in this sub-namespace. The Metamodel is the core resource for the structure of the Asset Administration Shell and provides the frame for all further specifications. The following entities are defined in the Metamodel but also serve as an example how to use the 'Asset Administration Shell Identifiers' in general. + +## Status: Accepted + +The sub-namespace AAS have been accepted by the Coordination Board. +The identifiers are derived following the grammar as defined in IDTA-01001-3-0. The grammar has been accepted by the Coordination Board + + +// Enum AasIdentifiables + +## AasIdentifiables + Enumeration of all referable elements within an Asset Administration Shell. + Contains IdentifiableElements + + [https://admin-shell.io/aas/3/0/AasIdentifiables](https://admin-shell.io/aas/3/0/AasIdentifiables) The AasIdentifiables class as defined in IDTA-01001-3-0. + +## AasIdentifiables/AssetAdministrationShell + Asset Administration Shell + + [https://admin-shell.io/aas/3/0/AasIdentifiables/AssetAdministrationShell](https://admin-shell.io/aas/3/0/AasIdentifiables/AssetAdministrationShell) The NamedIndividual AssetAdministrationShell of the AasIdentifiables class as defined in IDTA-01001-3-0. + +## AasIdentifiables/ConceptDescription + Concept Description + + [https://admin-shell.io/aas/3/0/AasIdentifiables/ConceptDescription](https://admin-shell.io/aas/3/0/AasIdentifiables/ConceptDescription) The NamedIndividual ConceptDescription of the AasIdentifiables class as defined in IDTA-01001-3-0. + +## AasIdentifiables/Identifiable + Identifiable + + [https://admin-shell.io/aas/3/0/AasIdentifiables/Identifiable](https://admin-shell.io/aas/3/0/AasIdentifiables/Identifiable) The NamedIndividual Identifiable of the AasIdentifiables class as defined in IDTA-01001-3-0. + + +## AasIdentifiables/Submodel + Submodel + + [https://admin-shell.io/aas/3/0/AasIdentifiables/Submodel](https://admin-shell.io/aas/3/0/AasIdentifiables/Submodel) The NamedIndividual Submodel of the AasIdentifiables class as defined in IDTA-01001-3-0. + + +// Enum AasReferableNonIdentifiables + +## AasReferableNonIdentifiables + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables) The AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/AnnotatedRelationshipElement + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/AnnotatedRelationshipElement](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/AnnotatedRelationshipElement) The AasReferableNonIdentifiables AnnotatedRelationshipElement of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/BasicEventElement + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/BasicEventElement](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/BasicEventElement) The NamedIndividual BasicEventElement of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/Blob + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Blob](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Blob) The NamedIndividual Blob of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/Capability + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Capability](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Capability) The NamedIndividual Capability of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + + +## AasReferableNonIdentifiables/DataElement + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/DataElement](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/DataElement) The NamedIndividual DataElement of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/Entity + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Entity](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Entity) The NamedIndividual Entity of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + + +## AasReferableNonIdentifiables/EventElement + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/EventElement](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/EventElement) The NamedIndividual EventElement of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/File + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/File](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/File) The NamedIndividual File of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + + +## AasReferableNonIdentifiables/MultiLanguageProperty + Property with a value that can be provided in multiple languages. + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/MultiLanguageProperty](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/MultiLanguageProperty) The NamedIndividual MultiLanguageProperty of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/Operation + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Operation](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Operation) The NamedIndividual Operation of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/Property + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Property](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Property) The NamedIndividual Property of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/Range + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Range](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/Range) The NamedIndividual Range of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + + +## AasReferableNonIdentifiables/ReferenceElement + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/ReferenceElement](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/ReferenceElement) The NamedIndividual ReferenceElement of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/RelationshipElement + + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/RelationshipElement](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/RelationshipElement) The NamedIndividual RelationshipElement of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/SubmodelElement + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/SubmodelElement](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/SubmodelElement) The NamedIndividual SubmodelElement of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/SubmodelElementCollection + Collection of Submodel Elements + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/SubmodelElementCollection](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/SubmodelElementCollection) The NamedIndividual SubmodelElementCollection of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + +## AasReferableNonIdentifiables/SubmodelElementList + List of set of Submodel Elements + + [https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/SubmodelElementList](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/SubmodelElementList) The NamedIndividual SubmodelElementList of the AasReferableNonIdentifiables class as defined in IDTA-01001-3-0. + + +// Enum AasReferables + +## AasReferables + Enumeration of all referable elements within an Asset Administration Shell. + Contains IdentifiableElements + + [https://admin-shell.io/aas/3/0/AasReferables](https://admin-shell.io/aas/3/0/AasReferables) The AasReferables class as defined in IDTA-01001-3-0. + + +## AasReferables/AnnotatedRelationshipElement + + + [https://admin-shell.io/aas/3/0/AasReferables/AnnotatedRelationshipElement](https://admin-shell.io/aas/3/0/AasReferables/AnnotatedRelationshipElement) The AasReferables AnnotatedRelationshipElement of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/AssetAdministrationShell + Asset Administration Shell + + [https://admin-shell.io/aas/3/0/AasReferables/AssetAdministrationShel](https://admin-shell.io/aas/3/0/AasReferables/AssetAdministrationShel) The NamedIndividual AssetAdministrationShel of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/BasicEventElement + + + [https://admin-shell.io/aas/3/0/AasReferables/BasicEventElement](https://admin-shell.io/aas/3/0/AasReferables/BasicEventElement) The AasReferables BasicEventElement of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/Blob + + + [https://admin-shell.io/aas/3/0/AasReferables/Blob](https://admin-shell.io/aas/3/0/AasReferables/Blob) The AasReferables Blob of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/Capability + + [https://admin-shell.io/aas/3/0/AasReferables/Capability](https://admin-shell.io/aas/3/0/AasReferables/Capability) The AasReferables Capability of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/ConceptDescription + Concept Description + + [https://admin-shell.io/aas/3/0/AasReferables/ConceptDescription](https://admin-shell.io/aas/3/0/AasReferables/ConceptDescription) The NamedIndividual ConceptDescription of the AasReferables class as defined in IDTA-01001-3-0. + + +## AasReferables/DataElement + + + [https://admin-shell.io/aas/3/0/AasReferables/DataElement](https://admin-shell.io/aas/3/0/AasReferables/DataElement) The AasReferables DataElement of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/Entity + + + [https://admin-shell.io/aas/3/0/AasReferables/Entity](https://admin-shell.io/aas/3/0/AasReferables/Entity) The AasReferables Entity of the AasReferables class as defined in IDTA-01001-3-0. + + +## AasReferables/EventElement + + + [https://admin-shell.io/aas/3/0/AasReferables/EventElement](https://admin-shell.io/aas/3/0/AasReferables/EventElement) The AasReferables EventElement of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/File + + + [https://admin-shell.io/aas/3/0/AasReferables/File](https://admin-shell.io/aas/3/0/AasReferables/File) The AasReferables File of the AasReferables class as defined in IDTA-01001-3-0. + + +## AasReferables/Identifiable + Identifiable + + [https://admin-shell.io/aas/3/0/AasReferables/Identifiable](https://admin-shell.io/aas/3/0/AasReferables/Identifiable) The NamedIndividual Identifiable of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/MultiLanguageProperty + Property with a value that can be provided in multiple languages. + + [https://admin-shell.io/aas/3/0/AasReferables/MultiLanguageProperty](https://admin-shell.io/aas/3/0/AasReferables/MultiLanguageProperty) The AasReferables MultiLanguageProperty of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/Operation + + + [https://admin-shell.io/aas/3/0/AasReferables/Operation](https://admin-shell.io/aas/3/0/AasReferables/Operation) The AasReferables Operation of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/Property + + + [https://admin-shell.io/aas/3/0/AasReferables/Property](https://admin-shell.io/aas/3/0/AasReferables/Property) The NamedIndividual Property of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/Range + + + [https://admin-shell.io/aas/3/0/AasReferables/Range](https://admin-shell.io/aas/3/0/AasReferables/Range) The NamedIndividual Range of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/Referable + + + [https://admin-shell.io/aas/3/0/AasReferables/Referable](https://admin-shell.io/aas/3/0/AasReferables/Referable) The NamedIndividual Referable of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/ReferenceElement + + + [https://admin-shell.io/aas/3/0/AasReferables/ReferenceElement](https://admin-shell.io/aas/3/0/AasReferables/ReferenceElement) The NamedIndividual ReferenceElement of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/RelationshipElement + + + [https://admin-shell.io/aas/3/0/AasReferables/RelationshipElement](https://admin-shell.io/aas/3/0/AasReferables/RelationshipElement) The NamedIndividual RelationshipElement of the AasReferables class as defined in IDTA-01001-3-0. + + +## AasReferables/Submodel + Submodel + + [https://admin-shell.io/aas/3/0/AasReferables/Submodel](https://admin-shell.io/aas/3/0/AasReferables/Submodel) The NamedIndividual Submodel of the AasReferables class as defined in IDTA-01001-3-0. + + +## AasReferables/SubmodelElement + + [https://admin-shell.io/aas/3/0/AasReferables/SubmodelElement](https://admin-shell.io/aas/3/0/AasReferables/SubmodelElement) The NamedIndividual SubmodelElement of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/SubmodelElementCollection + Collection of Submodel Elements + + [https://admin-shell.io/aas/3/0/AasReferables/SubmodelElementCollection](https://admin-shell.io/aas/3/0/AasReferables/SubmodelElementCollection) The NamedIndividual SubmodelElementCollection of the AasReferables class as defined in IDTA-01001-3-0. + +## AasReferables/SubmodelElementList + List of set of Submodel Elements + + [https://admin-shell.io/aas/3/0/AasReferables/SubmodelElementList](https://admin-shell.io/aas/3/0/AasReferables/SubmodelElementList) The NamedIndividual SubmodelElementList of the AasReferables class as defined in IDTA-01001-3-0. + +// Enum AasSubmodelElements + +## AasSubmodelElements + Enumeration of all submodel elements within an Asset Administration Shell. + + [https://admin-shell.io/aas/3/0/AasSubmodelElements](https://admin-shell.io/aas/3/0/AasSubmodelElements) The AasSubmodelElements class as defined in IDTA-01001-3-0. + + +## AasSubmodelElements/AnnotatedRelationshipElement + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/AnnotatedRelationshipElement](https://admin-shell.io/aas/3/0/AasSubmodelElements/AnnotatedRelationshipElement) The NamedIndividual AnnotatedRelationshipElement of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/BasicEventElement + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/BasicEventElement](https://admin-shell.io/aas/3/0/AasSubmodelElements/BasicEventElement) The NamedIndividual BasicEventElement of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/Blob + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/Blob](https://admin-shell.io/aas/3/0/AasSubmodelElements/Blob) The NamedIndividual Blob of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/Capability + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/Capability](https://admin-shell.io/aas/3/0/AasSubmodelElements/Capability) The NamedIndividual Capability of the AasSubmodelElements class as defined in IDTA-01001-3-0. + + +## AasSubmodelElements/DataElement + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/DataElement](https://admin-shell.io/aas/3/0/AasSubmodelElements/DataElement) The NamedIndividual DataElement of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/Entity + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/Entity](https://admin-shell.io/aas/3/0/AasSubmodelElements/Entity) The NamedIndividual Entity of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/EventElement + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/EventElement](https://admin-shell.io/aas/3/0/AasSubmodelElements/EventElement) The NamedIndividual EventElement of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/File + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/File](https://admin-shell.io/aas/3/0/AasSubmodelElements/File) The NamedIndividual File of the AasSubmodelElements class as defined in IDTA-01001-3-0. + + +## AasSubmodelElements/MultiLanguageProperty + Property with a value that can be provided in multiple languages. + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/MultiLanguageProperty](https://admin-shell.io/aas/3/0/AasReferableNonIdentifiables/MultiLanguageProperty) The NamedIndividual MultiLanguageProperty of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/Operation + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/Operation](https://admin-shell.io/aas/3/0/AasSubmodelElements/Operation) The NamedIndividual Operation of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/Property + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/Property](https://admin-shell.io/aas/3/0/AasSubmodelElements/Property) The NamedIndividual Property of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/Range + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/Range](https://admin-shell.io/aas/3/0/AasSubmodelElements/Range) The NamedIndividual Range of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/ReferenceElement + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/ReferenceElement](https://admin-shell.io/aas/3/0/AasSubmodelElements/ReferenceElement) The NamedIndividual ReferenceElement of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/RelationshipElement + + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/RelationshipElement](https://admin-shell.io/aas/3/0/AasSubmodelElements/RelationshipElement) The NamedIndividual RelationshipElement of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/SubmodelElement + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/SubmodelElement](https://admin-shell.io/aas/3/0/AasSubmodelElements/SubmodelElement) The NamedIndividual SubmodelElement of the AAasSubmodelElements class as defined in IDTA-01001-3-0. + +## AAasSubmodelElements/SubmodelElementCollection + Collection of Submodel Elements + + [https://admin-shell.io/aas/3/0/AAasSubmodelElements/SubmodelElementCollection](https://admin-shell.io/aas/3/0/AasSubmodelElements/SubmodelElementCollection) The NamedIndividual SubmodelElementCollection of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +## AasSubmodelElements/SubmodelElementList + List of set of Submodel Elements + + [https://admin-shell.io/aas/3/0/AasSubmodelElements/SubmodelElementList](https://admin-shell.io/aas/3/0/AasSubmodelElements/SubmodelElementList) The NamedIndividual SubmodelElementList of the AasSubmodelElements class as defined in IDTA-01001-3-0. + +// AdministrativeInformation + +## AdministrativeInformation + Every Identifiable may have administrative information. Administrative information includes for example + +- information about the version of the element, +- information about who created the element +- information about the submodel template that guided the creation of the submodel + + [https://admin-shell.io/aas/3/0/AdministrativeInformation](https://admin-shell.io/aas/3/0/AdministrativeInformation) The AdministrativeInformation class as defined in IDTA-01001-3-0. + +## AdministrativeInformation/creator + The subject ID of the subject responsible for making the element + + [https://admin-shell.io/aas/3/0/AdministrativeInformation/creator](https://admin-shell.io/aas/3/0/AdministrativeInformation/creator) The attribute creator of the AdministrativeInformation class as defined in IDTA-01001-3-0. + +## AdministrativeInformation/revision + Revision of the element. Constraint AASd-005: A revision requires a version. This means, if there is no version there is no revision neither. + + [https://admin-shell.io/aas/3/0/AdministrativeInformation/revision](https://admin-shell.io/aas/3/0/AdministrativeInformation/revision) The attribute revision of the AdministrativeInformation class as defined in IDTA-01001-3-0. + +## AdministrativeInformation/templateId + Identifier of the template that guided the creation of the element + + [https://admin-shell.io/aas/3/0/AdministrativeInformation/creator](https://admin-shell.io/aas/3/0/AdministrativeInformation/templateId) The attribute templateId of the AdministrativeInformation class as defined in IDTA-01001-3-0. + +## AdministrativeInformation/version + Version of the element. + + [https://admin-shell.io/aas/3/0/AdministrativeInformation/version](https://admin-shell.io/aas/3/0/AdministrativeInformation/version) The attribute version of the AdministrativeInformation class as defined in IDTA-01001-3-0. + +// Submodel Element AnnotatedRelationshipElement + +## AnnotatedRelationshipElement + An annotated relationship element is an relationship element that can be annotated with additional data elements. + + [http://admin-shell.io/aas/3/0/AnnotatedRelationshipElement](http://admin-shell.io/aas/3/0/AnnotatedRelationshipElement) The AnnotatedRelationshipElement class as defined in IDTA-01001-3-0. + + +## AnnotatedRelationshipElement/annotations + Annotations that hold for the relationships between the two elements. + + [http://admin-shell.io/aas/3/0/AnnotatedRelationshipElement/annotations](http://admin-shell.io/aas/3/0/AnnotatedRelationshipElement/annotations) The attribute annotation of the AnnotatedRelationshipElement class as defined in IDTA-01001-3-0. + + +// AssetAdministrationShell + +## AssetAdministrationShell + Describes the Administration Shell for Assets, Products, Components, e.g. Machines + + [http://admin-shell.io/aas/3/0/AssetAdministrationShell](http://admin-shell.io/aas/3/0/AssetAdministrationShell) The AssetAdministrationShell class as defined in IDTA-01001-3-0. + + +## AssetAdministrationShell/assetInformation + Meta information about the asset the AAS is representing. + + [https://admin-shell.io/aas/3/0/AssetAdministrationShell/assetInformation](https://admin-shell.io/aas/3/0/AssetAdministrationShell/assetInformation) The attribute assetInformation of the AssetAdministrationShell class as defined in IDTA-01001-3-0. + +## AssetAdministrationShell/derivedFrom + This relation connects instances of AAS with their respective types. Refer to Asset Kind for further information of instance and type kinds. + + + [http://admin-shell.io/aas/3/0/AssetAdministrationShell/derivedFrom](http://admin-shell.io/aas/3/0/AssetAdministrationShell/derivedFrom) The attribute derivedFrom of the AssetAdministrationShell class as defined in IDTA-01001-3-0. + + + +## AssetAdministrationShell/submodels + Points from the Admin Shell to the Submodels that describe the Admin Shell of a given Asset + + [http://admin-shell.io/aas/3/0/AssetAdministrationShell/submodels](http://admin-shell.io/aas/3/0/AssetAdministrationShell/submodels) The attribute submodel of the AssetAdministrationShell class as defined in IDTA-01001-3-0. + + +// AssetInformation + + +## AssetInformation + In AssetInformation identifying meta data of the asset that is represented by an AAS is defined. The asset may either represent an asset type or an asset instance. The asset has a globally unique identifier plus – if needed – additional domain specific (proprietary) identifiers. However, to support the corner case of very first phase of lifecycle where a stabilised/constant global asset identifier does not already exist, the corresponding attribute “globalAssetId” is optional. + + [https://admin-shell.io/aas/3/0/AssetInformation](https://admin-shell.io/aas/3/0/AssetInformation) The AssetInformation class as defined in IDTA-01001-3-0. + +## AssetInformation/assetKind + Denotes whether the Asset of of kind 'Type' or 'Instance' or of kind 'not applicable'. + + [https://admin-shell.io/aas/3/0/AssetInformation/assetKind](https://admin-shell.io/aas/3/0/AssetInformation/assetKind) The attribute assetKind of the AssetInformation class as defined in IDTA-01001-3-0. + +## AssetInformation/assetType + In case AssetInformation/assetKind is applicable the AssetInformation/assetType is the asset ID of the type asset of the asset under consideration as identified by AssetInformation/globalAssetId. + + [https://admin-shell.io/aas/3/0/AssetInformation/assetType](https://admin-shell.io/aas/3/0/AssetInformation/assetType) The attribute assetType of the AssetInformation class as defined in IDTA-01001-3-0. + +## AssetInformation/globalAssetId + Reference to either an Asset object or a global reference to the asset the AAS is representing. This attribute is required as soon as the AAS is exchanged via partners in the life cycle of the asset. In a first phase of the life cycle the asset might not yet have a global id but already an internal identifier. The internal identifier would be modelled via “externalAssetId”. + + [https://admin-shell.io/aas/3/0/AssetInformation/globalAssetId](https://admin-shell.io/aas/3/0/AssetInformation/globalAssetId) The attribute globalAssetId of the AssetInformation class as defined in IDTA-01001-3-0. + +## AssetInformation/specificAssetIds + Additional domain specific external, typically proprietary Identifiers for the asset like e.g. serial number etc. + + [https://admin-shell.io/aas/3/0/AssetInformation/specificAssetIds](https://admin-shell.io/aas/3/0/AssetInformation/specificAssetIds) The attribute specificAssetId of the AssetInformation class as defined in IDTA-01001-3-0. + + +## AssetInformation/defaultThumbnail + Default thumbnail of the asset represented by the Asset Administration Shell. + + [https://admin-shell.io/aas/3/0/AssetInformation/defaultThumbnail](https://admin-shell.io/aas/3/0/AssetInformation/defaultThumbnail) The attribute defaultThumbnail of the AssetInformation class as defined in IDTA-01001-3-0. + +// Enum AssetKind + +## AssetKind + Enumeration denoting the kind of the asset. + + [http://admin-shell.io/aas/3/0/AssetKind](http://admin-shell.io/aas/3/0/AssetKind) The AssetKind class as defined in IDTA-01001-3-0. + + +## AssetKind/Instance + Concrete, clearly identifiable component of a certain type. + + [http://admin-shell.io/aas/3/0/AssetKind/INSTANCE](http://admin-shell.io/aas/3/0/AssetKind/INSTANCE) The NamedIndividual Instance of the AssetKind class as defined in IDTA-01001-3-0. + + +## AssetKind/NotApplicable + not applicable + + [https://admin-shell.io/aas/3/0/AssetKind/NotApplicable](https://admin-shell.io/aas/3/0/AssetKind/NotApplicable) The NamedIndividual NotApplicable of the AssetKind class as defined in IDTA-01001-3-0. + + +## AssetKind/Type + hardware or software element which specifies the common attributes shared by all instances of the type. + + [http://admin-shell.io/aas/3/0/AssetKind/TYPE](http://admin-shell.io/aas/3/0/AssetKind/TYPE) The NamedIndividual Type of the AssetKind class as defined in IDTA-01001-3-0. + + +// Submodel element BasicEventElement + +## BasicEventElement + A basic event. + + [http://admin-shell.io/aas/3/0/BasicEventElement](http://admin-shell.io/aas/3/0/BasicEventElement) The BasicEventElement class as defined in IDTA-01001-3-0. + + +## BasicEventElement/direction +Direction of event + +Can be { input, output } + + [https://admin-shell.io/aas/3/0/BasicEventElement/direction](https://admin-shell.io/aas/3/0/BasicEventElement/direction) The attribute direction of the BasicEventElement class as defined in IDTA-01001-3-0'. + + + + [https://admin-shell.io/aas/3/0/BasicEventElement/state](https://admin-shell.io/aas/3/0/BasicEventElement/state) The attribute state of the BasicEventElement class as defined in IDTA-01001-3-0'. + + +## BasicEventElement/lastUpdate + + + [https://admin-shell.io/aas/3/0/BasicEventElement/lastUpdate](https://admin-shell.io/aas/3/0/BasicEventElement/lastUpdate) The attribute lastUpdate of the BasicEventElement class as defined in IDTA-01001-3-0. + +## BasicEventElement/messageBroker + + [https://admin-shell.io/aas/3/0/BasicEventElement/messageBroker](https://admin-shell.io/aas/3/0/BasicEventElement/messageBroker) The attribute messageBroker of the BasicEventElement class as defined in IDTA-01001-3-0. + + +## BasicEventElement/messageTopic +Information for the outer message infrastructure to schedule the event for the respective communication channel. + + [https://admin-shell.io/aas/3/0/BasicEventElement/messageTopic](https://admin-shell.io/aas/3/0/BasicEventElement/messageTopic) The attribute messageTopic of the BasicEventElement class as defined in IDTA-01001-3-0. + +## BasicEventElement/maxInterval + + + [https://admin-shell.io/aas/3/0/BasicEventElement/maxInterval](https://admin-shell.io/aas/3/0/BasicEventElement/maxInterval) The attribute maxInterval of the BasicEventElement class as defined in IDTA-01001-3-0. + + +## BasicEventElement/minInterval + + + [https://admin-shell.io/aas/3/0/BasicEventElement/minInterval](https://admin-shell.io/aas/3/0/BasicEventElement/minInterval) The attribute minInterval of the BasicEventElement class as defined in IDTA-01001-3-0. + + +## BasicEventElement/observed + Reference to the data or other elements that are being observed. + + [https://admin-shell.io/aas/3/0/BasicEventElement/observed](https://admin-shell.io/aas/3/0/BasicEventElement/observed) The attribute observed of the BasicEventElement class as defined in IDTA-01001-3-0'. + + +## BasicEventElement/state +State of event + +Can be { on, off } + +// Submodel Element Blob + +## Blob + A Blob is a data element that represents a file that is contained with its source code in the value attribute. + + [http://admin-shell.io/aas/3/0/Blob](http://admin-shell.io/aas/3/0/Blob) The Blob class as defined in IDTA-01001-3-0. + + +## Blob/contentType +Content type of the content of the Blob. The mime type states which file extension the file has. Valid values are e.g. 'application/json', 'application/xls', 'image/jpg' The allowed values are defined as in RFC2046. + + [https://admin-shell.io/aas/3/0/Blob/contentType](https://admin-shell.io/aas/3/0/Blob/contentType) The attribute contentType of the Blob class as defined in IDTA-01001-3-0. + +## Blob/value + The NamedIndividual of the Blob instance of a blob data element. + + [https://admin-shell.io/aas/3/0/Blob/value](https://admin-shell.io/aas/3/0/Blob/value) The attribute value of the Blob class as defined in IDTA-01001-3-0. + + +// Data Type BlobType + +## BlobType + + + [http://admin-shell.io/aas/3/0/BlobType](http://admin-shell.io/aas/3/0/BlobType) The BlobType data type as defined in IDTA-01001-3-0. + +// Submodel Element Capability + +## Capability + A capability is the implementation-independent description of the potential of an asset to achieve a certain effect in the physical or virtual world. + + [http://admin-shell.io/aas/3/0/Capability](http://admin-shell.io/aas/3/0/Capability) The Capability class as defined in IDTA-01001-3-0. + +// ConceptDescription + +## ConceptDescription + The semantics of a property or other elements that may have a semantic description is defined by a concept description. The description of the concept should follow a standardized schema (realized as data specification template). + + [http://admin-shell.io/aas/3/0/ConceptDescription](http://admin-shell.io/aas/3/0/ConceptDescription) The ConceptDescription class as defined in IDTA-01001-3-0. + + +## ConceptDescription/isCaseOfs + Global reference to an external definition the concept is compatible to or was derived from. + + [http://admin-shell.io/aas/3/0/ConceptDescription/isCaseOfs](http://admin-shell.io/aas/3/0/ConceptDescription/isCaseOfs) The attribute isCaseOf of the ConceptDescription class as defined in IDTA-01001-3-0. + +// Data Type ContentType + +## ContentType + + + [http://admin-shell.io/aas/3/0/ContentType](http://admin-shell.io/aas/3/0/ContentType) The ContentType data type as defined in IDTA-01001-3-0. + +// Submodel Element Data Element + +## DataElement + A data element is a submodel element that is not further composed out of other submodel elements. + A data element is a submodel element that has a value. + The type of value differs for different subtypes of data elements. + + [http://admin-shell.io/aas/3/0/DataElement](http://admin-shell.io/aas/3/0/DataElement) The DataElement class as defined in IDTA-01001-3-0. + + +// DataSpecification + +## DataSpecification + DataSpecification contains the additional attributes to be added to the element instance that references the data specification template and meta information about the template itself as well as some meta inforamtion about the template. + + [http://admin-shell.io/aas/3/0/DataSpecification](http://admin-shell.io/aas/3/0/DataSpecification) The DataSpecification class as defined in IDTA-01001-3-0. + +## DataSpecification/administration + + + [http://admin-shell.io/aas/3/0/DataSpecification/administration](http://admin-shell.io/aas/3/0/DataSpecification/administration) The attribute administration of the DataSpecification class as defined in IDTA-01001-3-0. + +## DataSpecification/dataSpecificationContent + + + [http://admin-shell.io/aas/3/0/DataSpecification/dataSpecificationContent](http://admin-shell.io/aas/3/0/DataSpecification/dataSpecificationContent) The attribute dataSpecificationContent of the DataSpecification class as defined in IDTA-01001-3-0. + + +## DataSpecification/description + + + [http://admin-shell.io/aas/3/0/DataSpecification/description](http://admin-shell.io/aas/3/0/DataSpecification/description) The attribute description of the DataSpecification class as defined in IDTA-01001-3-0. + + +## DataSpecification/id + + + [http://admin-shell.io/aas/3/0/DataSpecification/id](http://admin-shell.io/aas/3/0/DataSpecification/id) The attribute id of the DataSpecification class as defined in IDTA-01001-3-0. + + + +## DataSpecificationContent + DataSpecificationContent contains the additional attributes to be added to the element instance that references the data specification template and meta information about the template itself. + + [http://admin-shell.io/aas/3/0/DataSpecificationContent](http://admin-shell.io/aas/3/0/DataSpecificationContent) The DataSpecificationContent class as defined in IDTA-01001-3-0. + + + +// Enum DataTypeDefRdf + +## DataTypeDefRdf + Enumeration of all RDF data types + + [https://admin-shell.io/aas/3/0/DataTypeDefRdf](https://admin-shell.io/aas/3/0/DataTypeDefRdf) The DataTypeDefRdf class as defined in IDTA-01001-3-0. + + + +// Enum DataTypeDefXsd + +## DataTypeDefXsd + Enumeration of all RDF data types + + [https://admin-shell.io/aas/3/0/DataTypeDefXsd](https://admin-shell.io/aas/3/0/DataTypeDefXsd) The DataTypeDefXsd class as defined in IDTA-01001-3-0. + + + + +// Enum Direction + +## Direction + Enumeration for direction of an event element. + + [http://admin-shell.io/aas/3/0/Direction](http://admin-shell.io/aas/3/0/Direction) The Direction class as defined in IDTA-01001-3-0. + + +## Direction/input + + + [http://admin-shell.io/aas/3/0/AssetKind/input](http://admin-shell.io/aas/3/0/AssetKind/input) The NamedIndividual input of the enumeration class Direction as defined in IDTA-01001-3-0. + +## Direction/output + + + [http://admin-shell.io/aas/3/0/AssetKind/output](http://admin-shell.io/aas/3/0/AssetKind/output) The NamedIndividual output of the enumeration class Direction as defined in IDTA-01001-3-0. + +// Submodel Element Entity + +## Entity + An entity is a submodel element that is used to model entities. + + + [http://admin-shell.io/aas/3/0/Entity](http://admin-shell.io/aas/3/0/Entity) The Entity class as defined in IDTA-01001-3-0. + + +## Entity/entityType + Describes whether the entity is a co-managed entity or a self-managed entity. + + [http://admin-shell.io/aas/3/0/Entity/entityType](http://admin-shell.io/aas/3/0/Entity/entityType) The attribute entityType of the Entity class as defined in IDTA-01001-3-0. + + +## Entity/globalAssetId + Reference to the asset the entity is representing. + + [http://admin-shell.io/aas/3/0/Entity/globalAssetId](http://admin-shell.io/aas/3/0/Entity/globalAssetId) The attribute globalAssetId of the Entity class as defined in IDTA-01001-3-0. + +## Entity/specificAssetIds + Set of identifier key value pairs representing a specific identifier of the asset represented by the Asset Administration Shell. + + [http://admin-shell.io/aas/3/0/Entity/specificAssetIds](http://admin-shell.io/aas/3/0/Entity/specificAssetIds) The attribute specificAssetId of the Entity class as defined in IDTA-01001-3-0. + + +## Entity/statements + Describes statements applicable to the entity by a set of submodel elements, typically with a qualified value. + + [http://admin-shell.io/aas/3/0/Entity/statements](http://admin-shell.io/aas/3/0/Entity/statements) The attribute statement of the Entity class as defined in IDTA-01001-3-0. + +// Enum EntityType + +## EntityType + Enumeration for denoting whether an entity is a self-managed entity or a co-managed entity. + + [http://admin-shell.io/aas/3/0/EntityType](http://admin-shell.io/aas/3/0/EntityType) The EntityType class as defined in IDTA-01001-3-0. + + +## EntityType/CoManagedEntity + For co-managed entities there is no separate AAS. Co-managed entities need to be part of a self-managed entity. + + [http://admin-shell.io/aas/3/0/EntityType/CO_MANAGED_ENTITY](http://admin-shell.io/aas/3/0/EntityType/CO_MANAGED_ENTITY) The NamedIndividual CO_MANAGED_ENTITY of the EntityType class as defined in IDTA-01001-3-0. + + +## EntityType/SelfManagedEntity + Self-Managed Entities have their own AAS but can be part of the bill of material of a composite self-managed entity. The asset of an I4.0 Component is a self-managed entity per definition. + + [http://admin-shell.io/aas/3/0/EntityType/SELF_MANAGED_ENTITY](http://admin-shell.io/aas/3/0/EntityType/SELF_MANAGED_ENTITY) The NamedIndividual SELF_MANAGED_ENTITY of the EntityType class as defined in IDTA-01001-3-0. + +## Environment + + + + [http://admin-shell.io/aas/3/0/Environment](http://admin-shell.io/aas/3/0/Environment) The Environment class as defined in IDTA-01001-3-0. + +## Environment/assetAdministrationShells + + Asset Administration Shells in the environment + + [http://admin-shell.io/aas/3/0/Environment/assetAdministrationShells](http://admin-shell.io/aas/3/0/Environment/assetAdministrationShells) The attribute assetAdministrationShell of the Environment class as defined in IDTA-01001-3-0. + +## Environment/conceptDescriptions + + Concept descriptions in the environment + + [http://admin-shell.io/aas/3/0/Environment/conceptDescriptions](http://admin-shell.io/aas/3/0/Environment/conceptDescriptions) The attribute conceptDescription of the Environment class as defined in IDTA-01001-3-0. + + +## Environment/submodels + + Submodels in the environment + + [http://admin-shell.io/aas/3/0/Environment/submodels](http://admin-shell.io/aas/3/0/Environment/submodels) The attribute submodel of the Environment class as defined in IDTA-01001-3-0. + + +// Extension + +## Extension + Single extension of an element. + + [https://admin-shell.io/aas/3/0/Extension](https://admin-shell.io/aas/3/0/Extension) The Extension class as defined in IDTA-01001-3-0. + +## Extension/name + Name of the extension. + + [https://admin-shell.io/aas/3/0/Extension/name](https://admin-shell.io/aas/3/0/Extension/name) The attribute name of the Extension class as defined in IDTA-01001-3-0. + +## Extension/value + Value of the extension. + + + [https://admin-shell.io/aas/3/0/Extension/value](https://admin-shell.io/aas/3/0/Extension/value) The attibute value of the Extension class as defined in IDTA-01001-3-0. + +## Extension/valueType + Type of the value of the extension. + + [https://admin-shell.io/aas/3/0/Extension/valueType](https://admin-shell.io/aas/3/0/Extension/valueType) The attribute valueType of the Extension class as defined in IDTA-01001-3-0. + + +## Extension/refersTos + Reference to an element the extension refers to. + + [https://admin-shell.io/aas/3/0/Extension/refersTos](https://admin-shell.io/aas/3/0/Extension/refersTos) The attribute refersTo Extension class as defined in IDTA-01001-3-0. + +// Submodel Element EventElement + +## EventElement + Defines the necessary information for sending or receiving events. + + [http://admin-shell.io/aas/3/0/EventElement](http://admin-shell.io/aas/3/0/EventElement) The EventElement class as defined in IDTA-01001-3-0. + +// EventPayload + +## EventPayload + + + [http://admin-shell.io/aas/3/0/EventPayload](http://admin-shell.io/aas/3/0/EventPayload) The EventPayload class as defined in IDTA-01001-3-0. + + +## EventPayload/payload + + + [http://admin-shell.io/aas/3/0/EventPayload/payload](http://admin-shell.io/aas/3/0/EventPayload/payload) The attribute payload of the EventPayload class as defined in IDTA-01001-3-0. + + +## EventPayload/observableReference + + + [http://admin-shell.io/aas/3/0/EventPayload/observableReference](http://admin-shell.io/aas/3/0/EventPayload/observableReference) The attribute observableReference of the EventPayload class as defined in IDTA-01001-3-0. + +## EventPayload/observableSemanticId + + + [http://admin-shell.io/aas/3/0/EventPayload/observableSemanticId](http://admin-shell.io/aas/3/0/EventPayload/observableSemanticId) The attribute observableSemanticId of the EventPayload class as defined in IDTA-01001-3-0. + + +## EventPayload/source + + + [http://admin-shell.io/aas/3/0/EventPayload/source](http://admin-shell.io/aas/3/0/EventPayload/source) The attribute source of the EventPayload class as defined in IDTA-01001-3-0. + +## EventPayload/sourceSemanticId + + + [http://admin-shell.io/aas/3/0/EventPayload/sourceSemanticId](http://admin-shell.io/aas/3/0/EventPayload/sourceSemanticId) The attribute sourceSemanticId of the EventPayload class as defined in IDTA-01001-3-0. + + + +## EventPayload/subjectId + + + [http://admin-shell.io/aas/3/0/EventPayload/subjectId](http://admin-shell.io/aas/3/0/EventPayload/subjectId) The attribute subjectId of the EventPayload class as defined in IDTA-01001-3-0. + +## EventPayload/timestamp + + + [http://admin-shell.io/aas/3/0/EventPayload/timestamp](http://admin-shell.io/aas/3/0/EventPayload/timestamp) The attribute timestamp of the EventPayload class as defined in IDTA-01001-3-0. + +## EventPayload/topic + + + [http://admin-shell.io/aas/3/0/EventPayload/topic](http://admin-shell.io/aas/3/0/EventPayload/topic) The attribute topic of the EventPayload class as defined in IDTA-01001-3-0. + +// Submodel Element File + +## File + A File is a data element that represents a file via its path description. + + [http://admin-shell.io/aas/3/0/File](http://admin-shell.io/aas/3/0/File) The File class as defined in IDTA-01001-3-0. + + +## File/contentType + Content type of the content of the File. + + [https://admin-shell.io/aas/3/0/File/contentType](https://admin-shell.io/aas/3/0/File/contentType) The attribute contentType of the File class as defined in IDTA-01001-3-0. + +## File/value + Path and name of the referenced file (with file extension). The path can be absolute or relative. + + [https://admin-shell.io/aas/3/0/File/value](https://admin-shell.io/aas/3/0/File/value) The attribute value of the File class as defined in IDTA-01001-3-0. + +// Enum FragementKeys + +## FragmentKeys + Enumeration of different fragment key value types within a key + + [https://admin-shell.io/aas/3/0/FragmentKeys](https://admin-shell.io/aas/3/0/FragmentKeys) The FragmentKeys class as defined in IDTA-01001-3-0. + + +## FragmentKeys/AnnotatedRelationshipElement + + + [https://admin-shell.io/aas/3/0/FragmentKeys/AnnotatedRelationshipElement](https://admin-shell.io/aas/3/0/FragmentKeys/AnnotatedRelationshipElement) The NamedIndividual AnnotatedRelationshipElement of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/BasicEventElement + + + [https://admin-shell.io/aas/3/0/FragmentKeys/BasicEventElement](https://admin-shell.io/aas/3/0/FragmentKeys/BasicEventElement) The NamedIndividual BasicEventElement of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/Blob + + + [https://admin-shell.io/aas/3/0/FragmentKeys/Blob](https://admin-shell.io/aas/3/0/FragmentKeys/Blob) The NamedIndividual Blob of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/Capability + + [https://admin-shell.io/aas/3/0/FragmentKeys/Capability](https://admin-shell.io/aas/3/0/FragmentKeys/Capability) The NamedIndividual Capability of the FragmentKeys class as defined in IDTA-01001-3-0. + + +## FragmentKeys/DataElement + + + [https://admin-shell.io/aas/3/0/FragmentKeys/DataElement](https://admin-shell.io/aas/3/0/FragmentKeys/DataElement) The NamedIndividual DataElement of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/Entity + + + [https://admin-shell.io/aas/3/0/FragmentKeys/Entity](https://admin-shell.io/aas/3/0/FragmentKeys/Entity) The NamedIndividual Entity of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/EventElement + + + [https://admin-shell.io/aas/3/0/FragmentKeys/EventElement](https://admin-shell.io/aas/3/0/FragmentKeys/EventElement) The NamedIndividual EventElement of the FragmentKeys class as defined in IDTA-01001-3-0. + + +## FragmentKeys/File + + + [https://admin-shell.io/aas/3/0/FragmentKeys/File](https://admin-shell.io/aas/3/0/FragmentKeys/File) The NamedIndividual File of the FragmentKeys class as defined in IDTA-01001-3-0. + + + +## FragmentKeys/FragmentReference + Bookmark or a similar local identifier of a subordinate part of a primary resource + + [https://admin-shell.io/aas/3/0/FragmentKeys/FragmentReference](https://admin-shell.io/aas/3/0/FragmentKeys/FragmentReference) The NamedIndividual FragmentReference of the FragmentKeys class as defined in IDTA-01001-3-0. + + + +## FragmentKeys/MultiLanguageProperty + Property with a value that can be provided in multiple languages. + + [https://admin-shell.io/aas/3/0/FragmentKeys/MultiLanguageProperty](https://admin-shell.io/aas/3/0/FragmentKeys/MultiLanguageProperty) The NamedIndividual MultiLanguageProperty of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/Operation + + + [https://admin-shell.io/aas/3/0/FragmentKeys/Operation](https://admin-shell.io/aas/3/0/FragmentKeys/Operation) The NamedIndividual Operation of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/Property + + + [https://admin-shell.io/aas/3/0/FragmentKeys/Property](https://admin-shell.io/aas/3/0/FragmentKeys/Property) The NamedIndividual Property of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/Range + + + [https://admin-shell.io/aas/3/0/FragmentKeys/Range](https://admin-shell.io/aas/3/0/FragmentKeys/Range) The NamedIndividual Range of the FragmentKeys class as defined in IDTA-01001-3-0. + + +## FragmentKeys/ReferenceElement + + + [https://admin-shell.io/aas/3/0/FragmentKeys/ReferenceElement](https://admin-shell.io/aas/3/0/FragmentKeys/ReferenceElement) The NamedIndividual ReferenceElement of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/RelationshipElement + + + [https://admin-shell.io/aas/3/0/FragmentKeys/RelationshipElement](https://admin-shell.io/aas/3/0/FragmentKeys/RelationshipElement) The NamedIndividual RelationshipElement of the FragmentKeys class as defined in IDTA-01001-3-0. + + +## FragmentKeys/SubmodelElement + + [https://admin-shell.io/aas/3/0/FragmentKeys/SubmodelElement](https://admin-shell.io/aas/3/0/FragmentKeys/SubmodelElement) The NamedIndividual SubmodelElement of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/SubmodelElementCollection + Collection of Submodel Elements + + [https://admin-shell.io/aas/3/0/FragmentKeys/SubmodelElementCollection](https://admin-shell.io/aas/3/0/FragmentKeys/SubmodelElementCollection) The NamedIndividual SubmodelElementCollection of the FragmentKeys class as defined in IDTA-01001-3-0. + +## FragmentKeys/SubmodelElementList + List of set of Submodel Elements + + [https://admin-shell.io/aas/3/0/FragmentKeys/SubmodelElementList](https://admin-shell.io/aas/3/0/FragmentKeys/SubmodelElementList) The NamedIndividual SubmodelElementList of the FragmentKeys class as defined in IDTA-01001-3-0. + +// Enum GenericFragmentKeys + +## GenericFragmentKeys + Enumeration of different fragment key value types within a key + + [https://admin-shell.io/aas/3/0/GenericFragmentKeys](https://admin-shell.io/aas/3/0/GenericFragmentKeys) The GenericFragmentKeys class as defined in IDTA-01001-3-0. + +## GenericFragmentKeys/FragmentReference + Bookmark or a similar local identifier of a subordinate part of a primary resource + + [https://admin-shell.io/aas/3/0/GenericFragmentKeys/FragmentReference](https://admin-shell.io/aas/3/0/GenericFragmentKeys/FragmentReference) The NamedIndividual FragmentReference of the GenericFragmentKeys class as defined in IDTA-01001-3-0. + +// Enum GenericGloballyIdentifiables + + ## GenericGloballyIdentifiables + Enumeration of different key value types within a key + + [https://admin-shell.io/aas/3/0/GenericGloballyIdentifiables](https://admin-shell.io/aas/3/0/GenericGloballyIdentifiables) The GenericGloballyIdentifiables class as defined in IDTA-01001-3-0. + +## GenericGloballyIdentifiables/GlobalReference + + [https://admin-shell.io/aas/3/0/GenericGloballyIdentifiables/GlobalReference](https://admin-shell.io/aas/3/0/GenericGloballyIdentifiables/GlobalReference) The NamedIndividual GlobalReference of the GenericGloballyIdentifiables class as defined in IDTA-01001-3-0. + +// Enum GloballyIdentifiables + +## GloballyIdentifiables + Enumeration of all referable elements within an Asset Administration Shell. Contains IdentifiableElements + + [https://admin-shell.io/aas/3/0/GloballyIdentifiables](https://admin-shell.io/aas/3/0/GloballyIdentifiables) The GloballyIdentifiables class as defined in IDTA-01001-3-0. + +## GloballyIdentifiables/AssetAdministrationShell + Asset Administration Shell + + [https://admin-shell.io/aas/3/0/GloballyIdentifiables/AssetAdministrationShel](https://admin-shell.io/aas/3/0/GloballyIdentifiables/AssetAdministrationShel) The NamedIndividual AssetAdministrationShel of the GloballyIdentifiables class as defined in IDTA-01001-3-0. + +## GloballyIdentifiables/ConceptDescription + Concept Description + + [https://admin-shell.io/aas/3/0/GloballyIdentifiables/ConceptDescription](https://admin-shell.io/aas/3/0/GloballyIdentifiables/ConceptDescription) The NamedIndividual ConceptDescription of the GloballyIdentifiables class as defined in IDTA-01001-3-0. + +## GloballyIdentifiables/GlobalReference + + [https://admin-shell.io/aas/3/0/GloballyIdentifiables/GlobalReference](https://admin-shell.io/aas/3/0/GloballyIdentifiables/GlobalReference) The NamedIndividual GlobalReference of the GloballyIdentifiables class as defined in IDTA-01001-3-0. + +## GloballyIdentifiables/Identifiable + Identifiable + + [https://admin-shell.io/aas/3/0/GloballyIdentifiables/Identifiable](https://admin-shell.io/aas/3/0/GloballyIdentifiables/Identifiable) The NamedIndividual Identifiable of the GloballyIdentifiables class as defined in IDTA-01001-3-0. + + +## GloballyIdentifiables/Submodel + Submodel + + [https://admin-shell.io/aas/3/0/GloballyIdentifiables/Submodel](https://admin-shell.io/aas/3/0/GloballyIdentifiables/Submodel) The NamedIndividual Submodel of the GloballyIdentifiables class as defined in IDTA-01001-3-0. + +// HasExtensions + +## HasExtensions + Element that can be extended by proprietary extensions. + + [https://admin-shell.io/aas/3/0/HasExtensions](https://admin-shell.io/aas/3/0/HasExtensions) The HasExtensions class as defined in IDTA-01001-3-0. + +## HasExtensions/extensions + An extension of the element. + + [https://admin-shell.io/aas/3/0/HasExtensions/extensions](https://admin-shell.io/aas/3/0/HasExtensions/extensions) The attribute extension of the HasExtensions class as defined in IDTA-01001-3-0. + +// HasDataSpecification + +## HasDataSpecification + Element that can have be extended by using data specification templates. A data specification template defines the additional attributes an element may or shall have. The data specifications used are explicitly specified with their id. + + [http://admin-shell.io/aas/3/0/HasDataSpecification](http://admin-shell.io/aas/3/0/HasDataSpecification) The HasDataSpecification class as defined in IDTA-01001-3-0. + + +## HasDataSpecification/dataSpecifications + Set of global references to a data specification template used by the element. + + [http://admin-shell.io/aas/3/0/HasDataSpecification/dataSpecifications](http://admin-shell.io/aas/3/0/HasDataSpecification/dataSpecifications) The attribute dataSpecification of the HasDataSpecification class as defined in IDTA-01001-3-0. + +// HasKind + +## HasKind + An element with a kind is an element that can either represent a type or an instance. Default for an element is that it is representing an instance. + + [http://admin-shell.io/aas/3/0/HasKind](http://admin-shell.io/aas/3/0/HasKind) The HasKind class as defined in IDTA-01001-3-0. + + +## HasKind/kind + ModelingKind of the element: either type or instance. + + [http://admin-shell.io/aas/3/0/HasKind/kind](http://admin-shell.io/aas/3/0/HasKind/kind) The attribute kind of the HasKind class as defined in IDTA-01001-3-0. + +// HasSemantics + +## HasSemantics + Element that can have a semantic definition. Identifier of the semantic definition of the element. It is called semantic id of the element. The semantic id may either reference an external global id or it may reference a referable model element of kind=Type that defines the semantics of the element. + + [http://admin-shell.io/aas/3/0/HasSemantics](http://admin-shell.io/aas/3/0/HasSemantics) The HasSemantics class as defined in IDTA-01001-3-0. + + +## HasSemantics/semanticId + Points to the Expression Semantic of the Submodels + + [http://admin-shell.io/aas/3/0/HasSemantics/semanticId](http://admin-shell.io/aas/3/0/HasSemantics/semanticId) The attribute semanticId of the HasSemantics class as defined in IDTA-01001-3-0. + +## HasSemantics/supplementalSemanticIds + Identifier of a supplemental semantic definition of the element called supplemental semantic ID of the element + + [https://admin-shell.io/aas/3/0/HasSemantics/supplementalSemanticIds](https://admin-shell.io/aas/3/0/HasSemantics/supplementalSemanticIds) The attribute supplementalSemanticId of the HasSemantics class as defined in IDTA-01001-3-0. + +// Identifiable + +## Identifiable + An element that has a globally unique identifier. + + [http://admin-shell.io/aas/3/0/Identifiable](http://admin-shell.io/aas/3/0/Identifiable) The Identifiable class as defined in IDTA-01001-3-0. + + +## Identifiable/administration + Administrative information of an identifiable element. + + [http://admin-shell.io/aas/3/0/Identifiable/administration](http://admin-shell.io/aas/3/0/Identifiable/administration) The attribute administration of the Identifiable class as defined in IDTA-01001-3-0. + + +## Identifiable/id + The globally unique identification of the element. + + [https://admin-shell.io/aas/3/0/Identifiable/id](https://admin-shell.io/aas/3/0/Identifiable/id) The attribute identification of the Identifiable class as defined in IDTA-01001-3-0. + +// Data Type Identifier + +## Identifier + Data type of an identifier. + + [http://admin-shell.io/aas/3/0/Identifier](http://admin-shell.io/aas/3/0/Identifier) The Identifier data type as defined in IDTA-01001-3-0. + +// Key of a Reference + +## Key + A key is a reference to an element by its ID. + + [http://admin-shell.io/aas/3/0/Key](http://admin-shell.io/aas/3/0/Key) The Key class as defined in IDTA-01001-3-0. + + +## Key/type + Denote which kind of entity is referenced. In case type = GlobalReference then the element is a global unique id. In all other cases the key references a model element of the same or of another AAS. The name of the model element is explicitly listed. + + [http://admin-shell.io/aas/3/0/Key/type](http://admin-shell.io/aas/3/0/Key/type) The attribute type of the Key class as defined in IDTA-01001-3-0. + + +## Key/value + The key value, for example an IRDI if the idType=IRDI. + + [http://admin-shell.io/aas/3/0/Key/value](http://admin-shell.io/aas/3/0/Key/value) The attribute value of the Key class as defined in IDTA-01001-3-0. + +// Enum KeyTypes + +## KeyTypes + Enumeration of all referable elements within an Asset Administration Shell. Contains IdentifiableElements + + [https://admin-shell.io/aas/3/0/KeyTypes](https://admin-shell.io/aas/3/0/KeyTypes) The KeyTypes class as defined in IDTA-01001-3-0. + + + +## KeyTypes/AnnotatedRelationshipElement + + + [https://admin-shell.io/aas/3/0/KeyTypes/AnnotatedRelationshipElement](https://admin-shell.io/aas/3/0/KeyTypes/AnnotatedRelationshipElement) The NamedIndividual AnnotatedRelationshipElement of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/AssetAdministrationShell + Asset Administration Shell + + [https://admin-shell.io/aas/3/0/KeyTypes/AssetAdministrationShell](https://admin-shell.io/aas/3/0/KeyTypes/AssetAdministrationShell) The NamedIndividual AssetAdministrationShell of the KeyTypes class as defined in IDTA-01001-3-0. + + +## KeyTypes/BasicEventElement + + + [https://admin-shell.io/aas/3/0/KeyTypes/BasicEventElement](https://admin-shell.io/aas/3/0/KeyTypes/BasicEventElement) The NamedIndividual BasicEventElement of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/Blob + + + [https://admin-shell.io/aas/3/0/KeyTypes/Blob](https://admin-shell.io/aas/3/0/KeyTypes/Blob) The NamedIndividual Blob of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/Capability + + [https://admin-shell.io/aas/3/0/KeyTypes/Capability](https://admin-shell.io/aas/3/0/KeyTypes/Capability) The NamedIndividual Capability of the KeyTypes class as defined in IDTA-01001-3-0. + + +## KeyTypes/ConceptDescription + Concept Description + + [https://admin-shell.io/aas/3/0/KeyTypes/ConceptDescription](https://admin-shell.io/aas/3/0/KeyTypes/ConceptDescription) The NamedIndividual ConceptDescription of the KeyTypes class as defined in IDTA-01001-3-0. + + +## KeyTypes/DataElement + + + [https://admin-shell.io/aas/3/0/KeyTypes/DataElement](https://admin-shell.io/aas/3/0/KeyTypes/DataElement) The NamedIndividual DataElement of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/Entity + + + [https://admin-shell.io/aas/3/0/KeyTypes/Entity](https://admin-shell.io/aas/3/0/KeyTypes/Entity) The NamedIndividual Entity of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/EventElement + + + [https://admin-shell.io/aas/3/0/KeyTypes/EventElement](https://admin-shell.io/aas/3/0/KeyTypes/EventElement) The NamedIndividual EventElement of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/File + + + [https://admin-shell.io/aas/3/0/KeyTypes/File](https://admin-shell.io/aas/3/0/KeyTypes/File) The NamedIndividual File of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/FragmentReference + + + [https://admin-shell.io/aas/3/0/KeyTypes/FragmentReference](https://admin-shell.io/aas/3/0/KeyTypes/FragmentReference) The NamedIndividual FragmentReference of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/GlobalReference + + + [https://admin-shell.io/aas/3/0/KeyTypes/GlobalReference](https://admin-shell.io/aas/3/0/KeyTypes/GlobalReference) The NamedIndividual GlobalReference of the KeyTypes class as defined in IDTA-01001-3-0. + + +## KeyTypes/Identifiable + Identifiable + + [https://admin-shell.io/aas/3/0/KeyTypes/Identifiable](https://admin-shell.io/aas/3/0/KeyTypes/Identifiable) The NamedIndividual Identifiable of the KeyTypes class as defined in IDTA-01001-3-0. + + +## KeyTypes/MultiLanguageProperty + Property with a value that can be provided in multiple languages. + + [https://admin-shell.io/aas/3/0/KeyTypes/MultiLanguageProperty](https://admin-shell.io/aas/3/0/KeyTypes/MultiLanguageProperty) The KeyTypes MultiLanguageProperty of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/Operation + + + [https://admin-shell.io/aas/3/0/KeyTypes/Operation](https://admin-shell.io/aas/3/0/KeyTypes/Operation) The KeyTypes Operation of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/Property + + + [https://admin-shell.io/aas/3/0/KeyTypes/Property](https://admin-shell.io/aas/3/0/KeyTypes/Property) The NamedIndividual Property of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/Range + + + [https://admin-shell.io/aas/3/0/KeyTypes/Range](https://admin-shell.io/aas/3/0/KeyTypes/Range) The NamedIndividual Range of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/Referable + + + [https://admin-shell.io/aas/3/0/KeyTypes/Referable](https://admin-shell.io/aas/3/0/KeyTypes/Referable) The NamedIndividual Referable of the KeyTypes class as defined in IDTA-01001-3-0. + + +## KeyTypes/ReferenceElement + + + [https://admin-shell.io/aas/3/0/KeyTypes/ReferenceElement](https://admin-shell.io/aas/3/0/KeyTypes/ReferenceElement) The NamedIndividual ReferenceElement of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/RelationshipElement + + + [https://admin-shell.io/aas/3/0/KeyTypes/RelationshipElement](https://admin-shell.io/aas/3/0/KeyTypes/RelationshipElement) The NamedIndividual RelationshipElement of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/Submodel + Submodel + + [https://admin-shell.io/aas/3/0/KeyTypes/Submodel](https://admin-shell.io/aas/3/0/KeyTypes/Submodel) The NamedIndividual Submodel of the KeyTypes class as defined in IDTA-01001-3-0. + + +## KeyTypes/SubmodelElement + + [https://admin-shell.io/aas/3/0/KeyTypes/SubmodelElement](https://admin-shell.io/aas/3/0/KeyTypes/SubmodelElement) The NamedIndividual SubmodelElement of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/SubmodelElementCollection + Collection of Submodel Elements + + [https://admin-shell.io/aas/3/0/KeyTypes/SubmodelElementCollection](https://admin-shell.io/aas/3/0/KeyTypes/SubmodelElementCollection) The NamedIndividual SubmodelElementCollection of the KeyTypes class as defined in IDTA-01001-3-0. + +## KeyTypes/SubmodelElementList + List of set of Submodel Elements + + [https://admin-shell.io/aas/3/0/KeyTypes/SubmodelElementList](https://admin-shell.io/aas/3/0/KeyTypes/SubmodelElementList) The NamedIndividual SubmodelElementList of the KeyTypes class as defined in IDTA-01001-3-0. + + +// Data Type LabelType + +## LabelType + + + [http://admin-shell.io/aas/3/0/LabelType](http://admin-shell.io/aas/3/0/LabelType) The LabelType data type as defined in IDTA-01001-3-0. + +// Data Type LangStringSet + +## LangStringSet + + + [http://admin-shell.io/aas/3/0/LangStringSet](http://admin-shell.io/aas/3/0/LangStringSet) The LangStringSet data type as defined in IDTA-01001-3-0. + +// Data Type MessageTopicType + +## MessageTopicType + + + [http://admin-shell.io/aas/3/0/MessageTopicType](http://admin-shell.io/aas/3/0/MessageTopicType) The MessageTopicType data type as defined in IDTA-01001-3-0. + +// Enum ModellingKind + +## ModellingKind + Enumeration for denoting whether an element is a type or an instance. + + [https://admin-shell.io/aas/3/0/ModellingKind](https://admin-shell.io/aas/3/0/ModellingKind) The ModellingKind class as defined IDTA-01001-3-0. + +## ModellingKind/Instance + Concrete, clearly identifiable component of a certain template. + + [http://admin-shell.io/aas/3/0/ModellingKind/INSTANCE](http://admin-shell.io/aas/3/0/ModellingKind/INSTANCE) The NamedIndividual INSTANCE of the ModelingKind class as defined in IDTA-01001-3-0. + + +## ModellingKind/Template + Software element which specifies the common attributes shared by all instances of the template. + + [http://admin-shell.io/aas/3/0/ModellingKind/Template](http://admin-shell.io/aas/3/0/ModellingKind/Template) The NamedIndividual Templateof the ModellingKind class as defined in IDTA-01001-3-0. + +// Data Type MultiLanguageNameType + +## MultiLanguageNameType + + + [http://admin-shell.io/aas/3/0/MultiLanguageNameType](http://admin-shell.io/aas/3/0/MultiLanguageNameType) The MultiLanguageNameType data type as defined in IDTA-01001-3-0. + + +// Submodel Element MultiLanguageProperty + +## MultiLanguageProperty + A property is a data element that has a multi language value. + + [http://admin-shell.io/aas/3/0/MultiLanguageProperty](http://admin-shell.io/aas/3/0/MultiLanguageProperty) The MultiLanguageProperty class as defined in IDTA-01001-3-0. + + +## MultiLanguageProperty/value + The NamedIndividual of the property instance. + + [https://admin-shell.io/aas/3/0/MultiLanguageProperty/value](https://admin-shell.io/aas/3/0/MultiLanguageProperty/value) The attribute value of the MultiLanguageProperty class as defined in IDTA-01001-3-0. + +## MultiLanguageProperty/valueId + Reference to the global unqiue ID of a coded value. + + [https://admin-shell.io/aas/3/0/MultiLanguageProperty/valueId](https://admin-shell.io/aas/3/0/MultiLanguageProperty/valueId) The attribute valueId of the MultiLanguageProperty class as defined in IDTA-01001-3-0. + +// Data Type MultiLanguageTextType + +## MultiLanguageTextType + + + [http://admin-shell.io/aas/3/0/MultiLanguageTextType](http://admin-shell.io/aas/3/0/MultiLanguageTextType) The MultiLanguageTextType data type as defined in IDTA-01001-3-0. + +// Data Type NameType + +## NameType + + + [http://admin-shell.io/aas/3/0/NameType](http://admin-shell.io/aas/3/0/NameType) The NameType data type as defined in IDTA-01001-3-0. + +// Submodel Element Operation + +## Operation + An operation is a submodel element with input and output variables. + + [http://admin-shell.io/aas/3/0/Operation](http://admin-shell.io/aas/3/0/Operation) The Operation class as defined in IDTA-01001-3-0. + + +## Operation/inoutputVariables + Parameters that is input and output of the operation. + + [http://admin-shell.io/aas/3/0/Operation/inoutputVariables](http://admin-shell.io/aas/3/0/Operation/inoutputVariables) The attribute inoutputVariable of the Operation class as defined in IDTA-01001-3-0. + + +## Operation/inputVariables + Input parameters of the operation. + + [http://admin-shell.io/aas/3/0/Operation/inputVariables](http://admin-shell.io/aas/3/0/Operation/inputVariables) The attribute inputVariable of the Operation class as defined in IDTA-01001-3-0. + + +## Operation/outputVariables + Output parameters of the operation. + + [http://admin-shell.io/aas/3/0/Operation/outputVariable](http://admin-shell.io/aas/3/0/Operation/outputVariable) The attribute outputVariable of the Operation class as defined in IDTA-01001-3-0. + +// OperationVariable + +## OperationVariable + + + [http://admin-shell.io/aas/3/0/OperationVariable](http://admin-shell.io/aas/3/0/OperationVariable) The OperationVariable class as defined in IDTA-01001-3-0. + + +## OperationVariable/value + Describes the needed argument for an operation via a submodel element of kind=Template. + + [http://admin-shell.io/aas/3/0/OperationVariable/value](http://admin-shell.io/aas/3/0/OperationVariable/value) The attribute value of the OperationVariable class as defined in IDTA-01001-3-0. + +// Data Type PathType + +## PathType + + + [http://admin-shell.io/aas/3/0/PathType](http://admin-shell.io/aas/3/0/PathType) The PathType data type as defined in IDTA-01001-3-0. + + + +// Submodel Element Property + +## Property + A property is a data element that has a single value. + + [http://admin-shell.io/aas/3/0/Property](http://admin-shell.io/aas/3/0/Property) The Property class as defined in IDTA-01001-3-0. + + +## Property/value + The NamedIndividual of the property instance. + + [https://admin-shell.io/aas/3/0/Property/value](https://admin-shell.io/aas/3/0/Property/value) The attribute value of the Property class as defined in IDTA-01001-3-0. + +## Property/valueId + Reference to the global unique ID of a coded value. + + [https://admin-shell.io/aas/3/0/Property/valueId](https://admin-shell.io/aas/3/0/Property/valueId) The attribute valueId of the Property class as defined in IDTA-01001-3-0. + + +## Property/valueType + Data type of the value attribute. + + [https://admin-shell.io/aas/3/0/Property/valueType](https://admin-shell.io/aas/3/0/Property/valueType) The attribute valueType of the Property class as defined in IDTA-01001-3-0. + +// Qualifiable + +## Qualifiable + Additional qualification of a qualifiable element. + + [http://admin-shell.io/aas/3/0/Qualifiable](http://admin-shell.io/aas/3/0/Qualifiable) The Qualifiable class as defined in IDTA-01001-3-0. + + +## Qualifiable/qualifiers + Additional qualification elements of a qualifiable element. + + [http://admin-shell.io/aas/3/0/Qualifiable/qualifiers](http://admin-shell.io/aas/3/0/Qualifiable/qualifiers) The attribute qualifier of the Qualifiable class as defined in IDTA-01001-3-0. + +// Qualifier + +## Qualifier + A qualifier is a type-value pair that makes additional statements w.r.t. the value of the element. + + [http://admin-shell.io/aas/3/0/Qualifier](http://admin-shell.io/aas/3/0/Qualifier) The Qualifier class as defined in IDTA-01001-3-0. + +## Qualifier/kind + The qualifier kind describes the kind of qualifier that is applied to the element. + + [https://admin-shell.io/aas/3/0/Qualifier/kind](https://admin-shell.io/aas/3/0/Qualifier/kind) The attribute kind of the Qualifier class as defined in IDTA-01001-3-0. + +## Qualifier/type + The qualifier type describes the type of the qualifier that is applied to the element. + + [http://admin-shell.io/aas/3/0/Qualifier/type](http://admin-shell.io/aas/3/0/Qualifier/type) The attribute type of the Qualifier class as defined in IDTA-01001-3-0. + +## Qualifier/value + The qualifier value is the value of the qualifier. + + [http://admin-shell.io/aas/3/0/Qualifier/value](http://admin-shell.io/aas/3/0/Qualifier/value) The attribute value of the Qualifier class as defined in IDTA-01001-3-0. + + +## Qualifier/valueId + Reference to the global unqiue ID of a coded value. + + [http://admin-shell.io/aas/3/0/Qualifier/valueId](http://admin-shell.io/aas/3/0/Qualifier/valueId) The attribute valueId of the Qualifier class as defined in IDTA-01001-3-0. + + +## Qualifier/valueType + Data type of the qualifier value. + + [https://admin-shell.io/aas/3/0/Qualifier/valueType](https://admin-shell.io/aas/3/0/Qualifier/valueType) The attribute valueType of the Qualifier class as defined in IDTA-01001-3-0. + +// Enum QualifierKind + +## QualifierKind + + Enumeration of kinds of a qualifier + + [http://admin-shell.io/aas/3/0/QualifierKind](http://admin-shell.io/aas/3/0/QualifierKind) The QualifierKind data type as defined in IDTA-01001-3-0. + +## QualifierKind/ConceptQualifier + + + [https://admin-shell.io/aas/3/0/QualifierKind/ConceptQualifier](https://admin-shell.io/aas/3/0/QualifierKind/ConceptQualifier) The NamedIndividual ConceptQualifier of the AasIdentifiables class as defined in IDTA-01001-3-0. + +## QualifierKind/TemplateQualifier + + + [https://admin-shell.io/aas/3/0/QualifierKind/TemplateQualifier](https://admin-shell.io/aas/3/0/QualifierKind/TemplateQualifier) The NamedIndividual TemplateQualifier of the AasIdentifiables class as defined in IDTA-01001-3-0. + + +## QualifierKind/ValueQualifier + + + [https://admin-shell.io/aas/3/0/QualifierKind/ValueQualifier](https://admin-shell.io/aas/3/0/QualifierKind/ValueQualifier) The NamedIndividual ValueQualifier of the AasIdentifiables class as defined in IDTA-01001-3-0. + + + +// Data Type QualifierType + +## QualifierType + + + [http://admin-shell.io/aas/3/0/QualifierType](http://admin-shell.io/aas/3/0/QualifierType) The QualifierType data type as defined in IDTA-01001-3-0. + +// Submodel Element Range + +## Range + An element that is referable by its idShort. This id is not globally unique. This id is unique within the name space of the element. + + [http://admin-shell.io/aas/3/0/Range](http://admin-shell.io/aas/3/0/Range) The Range class as defined in IDTA-01001-3-0. + + +## Range/max + The maximum value of the range. + + [http://admin-shell.io/aas/3/0/Range/max](http://admin-shell.io/aas/3/0/Range/max) The attribute max of the Range class as defined in IDTA-01001-3-0. + + +## Range/min + The minimum value of the range. + + [http://admin-shell.io/aas/3/0/Range/min](http://admin-shell.io/aas/3/0/Range/min) The attribute min of the Range class as defined in IDTA-01001-3-0. + + +## Range/valueType + Data type of the min und max attributes + + [https://admin-shell.io/aas/3/0/Range/valueType](https://admin-shell.io/aas/3/0/Range/valueType) The attribute valueType of the Range class as defined in IDTA-01001-3-0. + +// Referable + +## Referable + An element that is referable by its idShort. This id is not globally unique. This id is unique within the name space of the element. + + [http://admin-shell.io/aas/3/0/Referable](http://admin-shell.io/aas/3/0/Referable) The Referable class as defined in IDTA-01001-3-0. + + +## Referable/category + The category is a value that gives further meta information w.r.t. to the class of the element. It affects the expected existence of attributes and the applicability of constraints. + + [http://admin-shell.io/aas/3/0/Referable/category](http://admin-shell.io/aas/3/0/Referable/category) The attribute category of the Referable class as defined in IDTA-01001-3-0. + + +## Referable/description + Description or comments on the element. The description can be provided in several languages. + + [http://admin-shell.io/aas/3/0/Referable/description](http://admin-shell.io/aas/3/0/Referable/description) The attribute description of the Referable class as defined in IDTA-01001-3-0. + + +## Referable/displayName + Display name. Can be provided in several languages. + +[https://admin-shell.io/aas/3/0/Referable/displayName](https://admin-shell.io/aas/3/0/Referable/displayName) The attribute displayName of the Referable class as defined in IDTA-01001-3-0. + +## Referable/idShort + Identifying string of the element within its name space. + + [http://admin-shell.io/aas/3/0/Referable/idShort](http://admin-shell.io/aas/3/0/Referable/idShort) The attribute idShort of the Referable class as defined in IDTA-01001-3-0. + +// Reference + +## Reference + Reference to either a model element of the same or another AAs or to an external entity. A reference is an ordered list of keys, each key referencing an element. The complete list of keys may for example be concatenated to a path that then gives unique access to an element or entity. + + [http://admin-shell.io/aas/3/0/Reference](http://admin-shell.io/aas/3/0/Reference) The Reference class as defined in IDTA-01001-3-0. + + +## Reference/keys + ordered list of keys + + [https://admin-shell.io/aas/3/0/Reference/keys](https://admin-shell.io/aas/3/0/Reference/keys) The attribute key of the Reference class as defined in IDTA-01001-3-0. + +## Reference/referredSemanticId + Expected semantic ID of the referenced model element (Reference/type=ModelReference); there typically is no semantic ID for for the referenced object of external references (Reference/type=ExternalReference). + + [https://admin-shell.io/aas/3/0/Reference/key](https://admin-shell.io/aas/3/0/Reference/referredSemanticId) The attribute referredSemanticId of the Reference class as defined in IDTA-01001-3-0. + +## Reference/type + Type of the reference + +Denotes whether reference is an external reference or a model reference + + [https://admin-shell.io/aas/3/0/Reference/type](https://admin-shell.io/aas/3/0/Reference/type) The attribute type of the Reference class as defined in IDTA-01001-3-0. + +// Submodel Element ReferenceElement + +## ReferenceElement + A reference element is a data element that defines a logical reference to another element within the same or another AAS or a reference to an external object or entity. + + [http://admin-shell.io/aas/3/0/ReferenceElement](http://admin-shell.io/aas/3/0/ReferenceElement) The ReferenceElement class as defined in IDTA-01001-3-0. + +## ReferenceElement/value + External reference to an external object or entity or a logical reference to another element within the same or another Asset Administration Shell (i.e. a model reference to a Referable) + + [https://admin-shell.io/aas/3/0/ReferenceElement/value](https://admin-shell.io/aas/3/0/ReferenceElement/value) The attribute value of the ReferenceElement class as defined in IDTA-01001-3-0. + +// Enum ReferenceTypes + +## ReferenceTypes + Enumeration for denoting whether an element is an external or model reference + + [https://admin-shell.io/aas/3/0/ReferenceTypes](https://admin-shell.io/aas/3/0/ReferenceTypes) The ReferenceTypes class as defined in IDTA-01001-3-0. + +## ReferenceTypes/ExternalReference + External reference + + [https://admin-shell.io/aas/3/0/ReferenceTypes/ExternalReference](https://admin-shell.io/aas/3/0/eferenceTypes/ExternalReference) The NamedIndividual ExternalReference of the ReferenceTypes class as defined in IDTA-01001-3-0. + +## ReferenceTypes/ModelReference + Model reference + + [https://admin-shell.io/aas/3/0/ReferenceTypes/ModelReference](https://admin-shell.io/aas/3/0/eferenceTypes/ModelReference) The NamedIndividual ModelReference of the ReferenceTypes class as defined in IDTA-01001-3-0. + +// Submodel Element RelationshipElement + +## RelationshipElement + + + [http://admin-shell.io/aas/3/0/RelationshipElement](http://admin-shell.io/aas/3/0/RelationshipElement) The RelationshipElement class as defined in IDTA-01001-3-0. + + +## RelationshipElement/first + First element in the relationship taking the role of the subject. + + + [http://admin-shell.io/aas/3/0/RelationshipElement/first](http://admin-shell.io/aas/3/0/RelationshipElement/first) The attribute first of the RelationshipElement class as defined in IDTA-01001-3-0. + + +## RelationshipElement/second + Second element in the relationship taking the role of the object. + + [http://admin-shell.io/aas/3/0/RelationshipElement/second](http://admin-shell.io/aas/3/0/RelationshipElement/second) The attribute second of the RelationshipElement class as defined in IDTA-01001-3-0. + +// Resource + +## Resource + Resource represents an address to a file (a locator). The NamedIndividual is a URI that can represent an absolute or relative path. + + [https://admin-shell.io/aas/3/0/Resource](https://admin-shell.io/aas/3/0/Resource) The Resource class as defined in IDTA-01001-3-0. + +## Resource/contentType + Content type of the content of the file + + The content type states which file extensions the file can have. + + [https://admin-shell.io/aas/3/0/Resource/contentType](https://admin-shell.io/aas/3/0/Resource/contentType) The attribute contentType of the Resource class as defined in IDTA-01001-3-0. + +## Resource/path + Path and name of the resource (with file extension) + + The path can be absolute or relative. + + [https://admin-shell.io/aas/3/0/Resource/path](https://admin-shell.io/aas/3/0/Resource/path) The attribute path of the Resource class as defined in IDTA-01001-3-0. + +// Data Type RevisionType + +## RevisionType + + + [http://admin-shell.io/aas/3/0/RevisionType](http://admin-shell.io/aas/3/0/RevisionType) The RevisionType data type as defined in IDTA-01001-3-0. + + +// SpecificAssetId + +## SpecificAssetId + A specific asset ID describes a generic supplementary identifying attribute of the asset. The specific asset ID is not necessarily globally unique. + + [https://admin-shell.io/aas/3/0/SpecificAssetId](https://admin-shell.io/aas/3/0/SpecificAssetId) The SpecificAssetId class as defined in IDTA-01001-3-0. + +## SpecificAssetId/externalSubjectId + The unique ID of the (external) subject the specific asset ID value belongs to or has meaning to. + + [http://admin-shell.io/aas/3/0/SpecificAssetId/externalSubjectId](http://admin-shell.io/aas/3/0/SpecificAssetId/externalSubjectId) The attribute externalSubjectId of the SpecificAsetId class as defined in IDTA-01001-3-0. + +## SpecificAssetId/name + Name of the asset identifier. + + [https://admin-shell.io/aas/3/0/SpecificAssetId/name](https://admin-shell.io/aas/3/0/SpecificAssetId/name) The attribute name of the SpecificAsetId class as defined in IDTA-01001-3-0. + + +## SpecificAssetId/value + value of the asset identifier. + + [https://admin-shell.io/aas/3/0/SpecificAssetId/value](https://admin-shell.io/aas/3/0/SpecificAssetId/value) The attribute value of the SpecificAsetId class as defined in IDTA-01001-3-0. + +// Submodel + +## Submodel + A Submodel defines a specific aspect of the asset represented by the AAS. A submodel is used to structure the virtual representation and technical functionality of an Administration Shell into distinguishable parts. Each submodel refers to a well-defined domain or subject matter. Submodels can become standardized and thus become submodels types. Submodels can have different life-cycles. + + [http://admin-shell.io/aas/3/0/Submodel](http://admin-shell.io/aas/3/0/Submodel) The Submodel class as defined in IDTA-01001-3-0. + + +## Submodel/submodelElements + A submodel consists of zero or more submodel elements. + + [http://admin-shell.io/aas/3/0/Submodel/submodelElements](http://admin-shell.io/aas/3/0/Submodel/submodelElements) The attribute submodelElement of the Submodel class as defined in IDTA-01001-3-0. + +// SubmodelElement + +## SubmodelElement + A submodel element is an element suitable for the description and differentiation of assets. + + [http://admin-shell.io/aas/3/0/SubmodelElement](http://admin-shell.io/aas/3/0/SubmodelElement) The SubmodelElement class as defined in IDTA-01001-3-0. + +// SubmodelElementCollection + +## SubmodelElementCollection + A submodel element collection is a set or list of submodel elements. + + [http://admin-shell.io/aas/3/0/SubmodelElementCollection](http://admin-shell.io/aas/3/0/SubmodelElementCollection) The SubmodelElementCollection class as defined in IDTA-01001-3-0. + + +## SubmodelElementCollection/value + Submodel element contained in the collection. + + [https://admin-shell.io/aas/3/0/SubmodelElementCollection/value](https://admin-shell.io/aas/3/0/SubmodelElementCollection/value)The attribute value of the SubmodelElementCollection class as defined in IDTA-01001-3-0. + +// SubmodelElementList + +## SubmodelElementList + List or set of submodel elements. + + [https://admin-shell.io/aas/3/0/SubmodelElementListhttps://admin-shell.io/aas/3/0/SubmodelElementList) The SubmodelElementList class as defined in IDTA-01001-3-0. + +## SubmodelElementList/orderRelevant + Defines whether order in list is relevant. If orderRelevant = false, the list represents a set or a bag. + +Default: True + + [https://admin-shell.io/aas/3/0/SubmodelElementList/orderRelevant](https://admin-shell.io/aas/3/0/SubmodelElementList/orderRelevant) The attribute orderRelevant of the SubmodelElementList class as defined in IDTA-01001-3-0. + +## SubmodelElementList/semanticIdListElement + Semantic ID which the submodel elements contained in the list match + + [https://admin-shell.io/aas/3/0/SubmodelElementList/semanticIdListElement](https://admin-shell.io/aas/3/0/SubmodelElementList/semanticIdListElement) The attribute semanticIdListElement of the SubmodelElementList class as defined in IDTA-01001-3-0. + +## SubmodelElementList/typeValueListElement + The submodel element type of the submodel elements contained in the list + + [https://admin-shell.io/aas/3/0/SubmodelElementList/typeValueListElement](https://admin-shell.io/aas/3/0/SubmodelElementList/typeValueListElement) The attribute typeValueListElement of the SubmodelElementList class as defined in IDTA-01001-3-0. + + +## SubmodelElementList/value + Submodel elements contained in the list. + + [https://admin-shell.io/aas/3/0/SubmodelElementList/value](https://admin-shell.io/aas/3/0/SubmodelElementList/value)The attribute value of the SubmodelElementList class as defined in IDTA-01001-3-0. + +## SubmodelElementList/valueTypeListElement + The submodel element type of the submodel elements contained in the list + + [https://admin-shell.io/aas/3/0/SubmodelElementList/valueTypeListElement](https://admin-shell.io/aas/3/0/SubmodelElementList/valueTypeListElement) The attribute valueTypeListElement of the SubmodelElementList class as defined in IDTA-01001-3-0. + +// Enum StateOfEvent + +## StateOfEvent + Enumeration for state of an event element. + + [http://admin-shell.io/aas/3/0/StateOfEvent](http://admin-shell.io/aas/3/0/StateOfEvent The StateOfEvent class as defined in IDTA-01001-3-0. + + +## StateOfEvent/on + + + [http://admin-shell.io/aas/3/0/StateOfEvent/on](http://admin-shell.io/aas/3/0/StateOfEvent/on) The NamedIndividual in of the enumeration class StateOfEvent as defined in IDTA-01001-3-0. + +## StateOfEvent/off + + + [http://admin-shell.io/aas/3/0/StateOfEvent/off](http://admin-shell.io/aas/3/0/StateOfEvent/off) The NamedIndividual offof the enumeration class StateOfEvent as defined in IDTA-01001-3-0. + +// Data Type ValueDataType + +## ValueDataType + + + [http://admin-shell.io/aas/3/0/ValueDataType](http://admin-shell.io/aas/3/0/ValueDataType) The ValueDataType data type as defined in IDTA-01001-3-0. + + + +// Data Type VersionType + +## VersionType + + + [http://admin-shell.io/aas/3/0/VersionType](http://admin-shell.io/aas/3/0/VersionType) The VersionType data type as defined in IDTA-01001-3-0. + + + +## Status: `approved` + diff --git a/aas/3/README.md b/aas/3/README.md index a50dc2d..e794c5e 100644 --- a/aas/3/README.md +++ b/aas/3/README.md @@ -1,7 +1,7 @@ -# AAS Metamodel Version 3 +# AAS Metamodel Version 3.x -This location contains the revisions of the third version of the AAS Metamodel. -Currently, one revision is in place as a Release Candidate. The major release -version 3.0 will be published soon: +This location contains the revisions of the third version of the AAS Metamodel, including its minor revisions. +Currently, one revision is in place as a Release Candidate. - [Release 3.0.RC01](./0/RC01/): Release Candidate from 2020 +- [Release 3.0](./0/): Version 3.0 from 2022 diff --git a/aas/API/1/0/RC01/README.md b/aas/API/1/0/RC01/README.md deleted file mode 100644 index dba23f4..0000000 --- a/aas/API/1/0/RC01/README.md +++ /dev/null @@ -1,411 +0,0 @@ -# AAS API Version 1.0 Release Candidate 01 (1.0RC01) - -This is the sub-namespace resevered for the Asset Administration Shell API -identifiers for version 1.0 (Candidate Release 01) [1]. - -## Introduction - -The content of this area is defined in the 'Details of the Asset Administration Shell - -Part 2'. Only identifiers that are defined in this document are allowed in this -sub-namespace. The identifiers are used to denote the different operations of -AAS interfaces. - -## Status: Accepted - -The content of the document and its identifiers have been accepted by the -IDTA Coordination Board. - - -## GetAssetAdministrationShell (Operation) - -[https://admin-shell.io/aas/API/GetAssetAdministrationShell/1/0/RC01](https://admin-shell.io/aas/API/GetAssetAdministrationShell/1/0/RC01): Returns the Asset Administration Shell - - -## PutAssetAdministrationShell (Operation) - -[https://admin-shell.io/aas/API/PutAssetAdministrationShell/1/0/RC01](https://admin-shell.io/aas/API/PutAssetAdministrationShell/1/0/RC01): Updates the Asset Administration Shell - - -## GetAllSubmodelReferences (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelReferences/1/0/RC01](https://admin-shell.io/aas/API/GetAllSubmodelReferences/1/0/RC01): Returns all Submodel References - - -## PostSubmodelReference (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelReference/1/0/RC01](https://admin-shell.io/aas/API/PostSubmodelReference/1/0/RC01): Creates a Submodel Reference at the Asset Administration Shell - - -## DeleteSubmodelReference (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelReference/1/0/RC01](https://admin-shell.io/aas/API/DeleteSubmodelReference/1/0/RC01): Deletes the Submodel Reference from the Asset Administration Shell - - -## GetAssetInformation (Operation) - -[https://admin-shell.io/aas/API/GetAssetInformation/1/0/RC01](https://admin-shell.io/aas/API/GetAssetInformation/1/0/RC01): Returns the Asset Information - - -## PutAssetInformation (Operation) - -[https://admin-shell.io/aas/API/PutAssetInformation/1/0/RC01](https://admin-shell.io/aas/API/PutAssetInformation/1/0/RC01): Updates the Asset Information - - -## GetSubmodel (Operation) - -[https://admin-shell.io/aas/API/GetSubmodel/1/0/RC01](https://admin-shell.io/aas/API/GetSubmodel/1/0/RC01): Returns the Submodel - - -## GetAllSubmodelElements (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelElements/1/0/RC01](https://admin-shell.io/aas/API/GetAllSubmodelElements/1/0/RC01): Returns all submodel elements including their hierarchy - - -## GetSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/GetSubmodelElementByPath/1/0/RC01](https://admin-shell.io/aas/API/GetSubmodelElementByPath/1/0/RC01): Returns a specific submodel element from the Submodel at a specified path - - -## PutSubmodel (Operation) - -[https://admin-shell.io/aas/API/PutSubmodel/1/0/RC01](https://admin-shell.io/aas/API/PutSubmodel/1/0/RC01): Updates the Submodel - - -## PostSubmodelElement (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelElement/1/0/RC01](https://admin-shell.io/aas/API/PostSubmodelElement/1/0/RC01): Creates a new submodel element as a child of the submodel. - - -## PostSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelElementByPath/1/0/RC01](https://admin-shell.io/aas/API/PostSubmodelElementByPath/1/0/RC01): Creates a new submodel element at a specified path within the submodel elements hierarchy. - - -## PutSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/PutSubmodelElementByPath/1/0/RC01](https://admin-shell.io/aas/API/PutSubmodelElementByPath/1/0/RC01): Updates an existing submodel element at a specified path within the submodel elements hierarchy - - -## SetSubmodelElementValueByPath (Operation) - -[https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/1/0/RC01](https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/1/0/RC01): Sets the value of the submodel element at a specified path according to the protocol-specific RAW-value payload - - -## DeleteSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/1/0/RC01](https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/1/0/RC01): Deletes a submodel element at a specified path within submodel elements hierarchy - - -## InvokeOperationSync (Operation) - -[https://admin-shell.io/aas/API/InvokeOperationSync/1/0/RC01](https://admin-shell.io/aas/API/InvokeOperationSync/1/0/RC01): Synchronously invokes an Operation at a specified path with a client timeout in ms - - -## InvokeOperationAsync (Operation) - -[https://admin-shell.io/aas/API/InvokeOperationAsync/1/0/RC01](https://admin-shell.io/aas/API/InvokeOperationAsync/1/0/RC01): Asynchronously invokes an Operation at a specified path with a client timeout in ms - - -## GetOperationAsyncResult (Operation) - -[https://admin-shell.io/aas/API/GetOperationAsyncResult/1/0/RC01](https://admin-shell.io/aas/API/GetOperationAsyncResult/1/0/RC01): Returns the OperationResult of an asynchronously invoked operation - - -## GenerateSerializationByIds (Operation) - -[https://admin-shell.io/aas/API/GenerateSerializationByIds/1/0/RC01](https://admin-shell.io/aas/API/GenerateSerializationByIds/1/0/RC01): Returns an appropriate serialization based on the specified format - - -## GetAllAASXPackageIds (Operation) - -[https://admin-shell.io/aas/API/GetAllAASXPackageIds/1/0/RC01](https://admin-shell.io/aas/API/GetAllAASXPackageIds/1/0/RC01): Returns a list of available AASX packages at the server - - -## GetAASXByPackageId (Operation) - -[https://admin-shell.io/aas/API/GetAASXByPackageId/1/0/RC01](https://admin-shell.io/aas/API/GetAASXByPackageId/1/0/RC01): Returns a specific AASX package from the server - - -## PostAASXPackage (Operation) - -[https://admin-shell.io/aas/API/PostAASXPackage/1/0/RC01](https://admin-shell.io/aas/API/PostAASXPackage/1/0/RC01): Creates an AASX package at the server - - -## PutAASXByPackageId (Operation) - -[https://admin-shell.io/aas/API/PutAASXByPackageId/1/0/RC01](https://admin-shell.io/aas/API/PutAASXByPackageId/1/0/RC01): Updates the AASX package at the server - - -## DeleteAASXByPackageId (Operation) - -[https://admin-shell.io/aas/API/DeleteAASXByPackageId/1/0/RC01](https://admin-shell.io/aas/API/DeleteAASXByPackageId/1/0/RC01): Deletes a specific AASX package - - -## GetAllAssetAdministrationShellDescriptors (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/1/0/RC01](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/1/0/RC01): Returns all Asset Administration Shell Descriptors from an AAS Registry - - -## GetAssetAdministrationShellDescriptorById (Operation) - -[https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/1/0/RC01](https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/1/0/RC01): Returns a specific Asset Administration Shell Descriptor from an AAS Registry - - -## PostAssetAdministrationShellDescriptor (Operation) - -[https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/1/0/RC01](https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/1/0/RC01): Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS at an AAS Registry - - -## PutAssetAdministrationShellDescriptorById (Operation) - -[https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/1/0/RC01](https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/1/0/RC01): Updates an existing Asset Administration Shell Descriptor - - -## DeleteAssetAdministrationShellDescriptorById (Operation) - -[https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/1/0/RC01](https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/1/0/RC01): Deletes an Asset Administration Shell Descriptor - - -## GetAllSubmodelDescriptors (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/1/0/RC01](https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/1/0/RC01): Returns all submodel descriptors - - -## GetSubmodelDescriptorById (Operation) - -[https://admin-shell.io/aas/API/GetSubmodelDescriptorById/1/0/RC01](https://admin-shell.io/aas/API/GetSubmodelDescriptorById/1/0/RC01): Returns a specific submodel descriptor - - -## PostSubmodelDescriptor (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelDescriptor/1/0/RC01](https://admin-shell.io/aas/API/PostSubmodelDescriptor/1/0/RC01): Creates a new submodel descriptor - - -## PutSubmodelDescriptorById (Operation) - -[https://admin-shell.io/aas/API/PutSubmodelDescriptorById/1/0/RC01](https://admin-shell.io/aas/API/PutSubmodelDescriptorById/1/0/RC01): Updates an existing submodel descriptor - - -## DeleteSubmodelDescriptorById (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/1/0/RC01](https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/1/0/RC01): Deletes a submodel descriptor - - -## GetAllAssetAdministrationShells (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/1/0/RC01](https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/1/0/RC01): Returns all Asset Administration Shells - - -## GetAssetAdministrationShellById (Operation) - -[https://admin-shell.io/aas/API/GetAssetAdministrationShellById/1/0/RC01](https://admin-shell.io/aas/API/GetAssetAdministrationShellById/1/0/RC01): Returns a specific Asset Administration Shell - - -## GetAllAssetAdministrationShellsByAssetId (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/1/0/RC01](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/1/0/RC01): Returns all Asset Administration Shells that are linked to a globally unique asset identifier or to specific asset ids. - - -## GetAllAssetAdministrationShellsByIdShort (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/1/0/RC01](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/1/0/RC01): -Returns all Asset Administration Shells with a specific idShort - - -## PostAssetAdministrationShell (Operation) - -[https://admin-shell.io/aas/API/PostAssetAdministrationShell/1/0/RC01](https://admin-shell.io/aas/API/PostAssetAdministrationShell/1/0/RC01): Creates a new Asset Administration Shell. - - -## PutAssetAdministrationShellById (Operation) - -[https://admin-shell.io/aas/API/PutAssetAdministrationShellById/1/0/RC01](https://admin-shell.io/aas/API/PutAssetAdministrationShellById/1/0/RC01): Updates an existing Asset Administration Shell - - -## DeleteAssetAdministrationShellById (Operation) - -[https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/1/0/RC01](https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/1/0/RC01): Deletes an Asset Administration Shell - - -## GetAllSubmodels (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodels/1/0/RC01](https://admin-shell.io/aas/API/GetAllSubmodels/1/0/RC01): Returns all Submodels - - -## GetSubmodelById (Operation) - -[https://admin-shell.io/aas/API/GetSubmodelById/1/0/RC01](https://admin-shell.io/aas/API/GetSubmodelById/1/0/RC01): Returns a specific Submodel - - -## GetAllSubmodelsBySemanticId (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/1/0/RC01](https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/1/0/RC01): Returns all Submodels with a specific SemanticId - - -## GetAllSubmodelsByIdShort (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/1/0/RC01](https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/1/0/RC01): Returns all Submodels with a specific idShort - - -## PostSubmodel (Operation) - -[https://admin-shell.io/aas/API/PostSubmodel/1/0/RC01](https://admin-shell.io/aas/API/PostSubmodel/1/0/RC01): Creates a new Submodel. - - -## PutSubmodelById (Operation) - -[https://admin-shell.io/aas/API/PutSubmodelById/1/0/RC01](https://admin-shell.io/aas/API/PutSubmodelById/1/0/RC01): Updates an existing Submodel - - -## DeleteSubmodelById (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelById/1/0/RC01](https://admin-shell.io/aas/API/DeleteSubmodelById/1/0/RC01): Deletes a Submodel - - -## GetAllConceptDescriptions (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptions/1/0/RC01](https://admin-shell.io/aas/API/GetAllConceptDescriptions/1/0/RC01): Returns all Concept Descriptions - - -## GetConceptDescriptionById (Operation) - -[https://admin-shell.io/aas/API/GetConceptDescriptionById/1/0/RC01](https://admin-shell.io/aas/API/GetConceptDescriptionById/1/0/RC01): Returns a specific Concept Description - - -## GetAllConceptDescriptionsByIdShort (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/1/0/RC01](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/1/0/RC01): Returns all Concept Descriptions with a specific idShort - - -## (Operation) - -[https://admin-shell.io/aas/API//1/0/RC01](https://admin-shell.io/aas/API//1/0/RC01): - - -## GetAllConceptDescriptionsByIsCaseOf (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/1/0/RC01](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/1/0/RC01): Returns all Concept Descriptions with a specific IsCaseOf-reference - - -## (Operation) - -[https://admin-shell.io/aas/API//1/0/RC01](https://admin-shell.io/aas/API//1/0/RC01): - - -## (Operation) - -[https://admin-shell.io/aas/API//1/0/RC01](https://admin-shell.io/aas/API//1/0/RC01): - - -## GetAllConceptDescriptionsByDataSpecificationReference (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/1/0/RC01](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/1/0/RC01): Returns all Concept Descriptions with a specific dataSpecification reference - - -## PostConceptDescription (Operation) - -[https://admin-shell.io/aas/API/PostConceptDescription/1/0/RC01](https://admin-shell.io/aas/API/PostConceptDescription/1/0/RC01): Creates a new Concept Description. - - -## PutConceptDescriptionById (Operation) - -[https://admin-shell.io/aas/API/PutConceptDescriptionById/1/0/RC01](https://admin-shell.io/aas/API/PutConceptDescriptionById/1/0/RC01): Updates an existing Concept Description - - -## DeleteConceptDescriptionById (Operation) - -[https://admin-shell.io/aas/API/DeleteConceptDescriptionById/1/0/RC01](https://admin-shell.io/aas/API/DeleteConceptDescriptionById/1/0/RC01): Deletes a Concept Description - - -## GetAllAssetAdministrationShellIdsByAssetLink (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/1/0/RC01](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/1/0/RC01): Returns a list of Asset Administration Shell ids based on Asset identifier key-value-pairs - - -## GetAllAssetLinksById (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetLinksById/1/0/RC01](https://admin-shell.io/aas/API/GetAllAssetLinksById/1/0/RC01): Returns a list of Asset identifier key-value-pairs based on an given Asset Administration Shell id - - -## PostAllAssetLinksById (Operation) - -[https://admin-shell.io/aas/API/PostAllAssetLinksById/1/0/RC01](https://admin-shell.io/aas/API/PostAllAssetLinksById/1/0/RC01): Creates or updates all Asset identifier key-value-pairs linked to an Asset Administration Shell to edit discoverable content - - -## DeleteAllAssetLinksById (Operation) - -[https://admin-shell.io/aas/API/DeleteAllAssetLinksById/1/0/RC01](https://admin-shell.io/aas/API/DeleteAllAssetLinksById/1/0/RC01): Deletes all Asset identifier key-value-pair linked to an Asset Administration Shell - - -## Descriptor (Class) - -[https://admin-shell.io/aas/API/DataTypes/Descriptor/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/Descriptor/1/0/RC01): The self-describing information of a network resource. - - -## AssetAdministrationShellDescriptor (Class) - -[https://admin-shell.io/aas/API/DataTypes/AssetAdministrationShellDescriptor/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/AssetAdministrationShellDescriptor/1/0/RC01): Descriptor of an Asset Administration Shell - - -## SubmodelDescriptor (Class) - -[https://admin-shell.io/aas/API/DataTypes/SubmodelDescriptor/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/SubmodelDescriptor/1/0/RC01): A descriptor of a submodel - - -## Endpoint (Class) - -[https://admin-shell.io/aas/API/DataTypes/Endpoint/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/Endpoint/1/0/RC01): The endpoint description of a network resource. - - -## ProtocolInformation (Class) - -[https://admin-shell.io/aas/API/DataTypes/ProtocolInformation/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/ProtocolInformation/1/0/RC01): The protocol information of a network resource endpoint will be defined in DIN SPEC 16593-2. - - -## Result (Class) - -[https://admin-shell.io/aas/API/DataTypes/Result/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/Result/1/0/RC01): The result object - - -## Message (Class) - -[https://admin-shell.io/aas/API/DataTypes/Message/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/Message/1/0/RC01): A message containing more information for the requester about a certain happening in the backend. - - -## MessageTypeEnum (Enumeration) - -[https://admin-shell.io/aas/API/DataTypes/MessageTypeEnum/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/MessageTypeEnum/1/0/RC01): The message type - - -## OperationRequest (Class) - -[https://admin-shell.io/aas/API/DataTypes/OperationRequest/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/OperationRequest/1/0/RC01): The operation request object - - -## OperationResult (Class) - -[https://admin-shell.io/aas/API/DataTypes/OperationResult/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/OperationResult/1/0/RC01): The operation’s invocation result object - - -## ExecutionState (Class) - -[https://admin-shell.io/aas/API/DataTypes/ExecutionState/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/ExecutionState/1/0/RC01): The operation’s invocation result state - - -## OperationHandle (Class) - -[https://admin-shell.io/aas/API/DataTypes/OperationHandle/1/0/RC01](https://admin-shell.io/aas/API/DataTypes/OperationHandle/1/0/RC01): The returned handle of an operation’s asynchronous invocation used to request the current state of the operation’s execution. - - - -## Contact - -The entries of this sub-namespace have been created by [Sebastian Bader](https://github.com/sebbader) -on behalf of the IDTA Working Group 'Asset Administration Shell'. -Contact via a [web form](https://www.plattform-i40.de/IP/Navigation/EN/ThePlatform/Contact/contact.html). - - -[1] S. Bader, B. Berres, B. Boss, A. Graf Gatterburg, M. Hoffmeister et al. -['Details of the Asset Administration Shell Part 2, Interoperability at Runtime – -Exchanging Information via Application Programming Interfaces'](), Version 1.0RC01, -Plattform Industrie 4.0, ZVEI, 2021 diff --git a/aas/API/1/0/RC02/README.md b/aas/API/1/0/RC02/README.md deleted file mode 100644 index 0830afd..0000000 --- a/aas/API/1/0/RC02/README.md +++ /dev/null @@ -1,411 +0,0 @@ -# AAS API Version 1.0 Release Candidate 02 (1.0RC02) - -This is the sub-namespace resevered for the Asset Administration Shell API -identifiers for version 1.0 (Candidate Release 02) [1]. - -## Introduction - -The content of this area is defined in the 'Details of the Asset Administration Shell - -Part 2'. Only identifiers that are defined in this document are allowed in this -sub-namespace. The identifiers are used to denote the different operations of -AAS interfaces. - -## Status: Accepted - -The content of the document and its identifiers have been accepted by the -IDTA Coordination Board. - - -## GetAssetAdministrationShell (Operation) - -[https://admin-shell.io/aas/API/GetAssetAdministrationShell/1/0/RC02](https://admin-shell.io/aas/API/GetAssetAdministrationShell/1/0/RC02): Returns the Asset Administration Shell - - -## PutAssetAdministrationShell (Operation) - -[https://admin-shell.io/aas/API/PutAssetAdministrationShell/1/0/RC02](https://admin-shell.io/aas/API/PutAssetAdministrationShell/1/0/RC02): Updates the Asset Administration Shell - - -## GetAllSubmodelReferences (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelReferences/1/0/RC02](https://admin-shell.io/aas/API/GetAllSubmodelReferences/1/0/RC02): Returns all Submodel References - - -## PostSubmodelReference (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelReference/1/0/RC02](https://admin-shell.io/aas/API/PostSubmodelReference/1/0/RC02): Creates a Submodel Reference at the Asset Administration Shell - - -## DeleteSubmodelReference (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelReference/1/0/RC02](https://admin-shell.io/aas/API/DeleteSubmodelReference/1/0/RC02): Deletes the Submodel Reference from the Asset Administration Shell - - -## GetAssetInformation (Operation) - -[https://admin-shell.io/aas/API/GetAssetInformation/1/0/RC02](https://admin-shell.io/aas/API/GetAssetInformation/1/0/RC02): Returns the Asset Information - - -## PutAssetInformation (Operation) - -[https://admin-shell.io/aas/API/PutAssetInformation/1/0/RC02](https://admin-shell.io/aas/API/PutAssetInformation/1/0/RC02): Updates the Asset Information - - -## GetSubmodel (Operation) - -[https://admin-shell.io/aas/API/GetSubmodel/1/0/RC02](https://admin-shell.io/aas/API/GetSubmodel/1/0/RC02): Returns the Submodel - - -## GetAllSubmodelElements (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelElements/1/0/RC02](https://admin-shell.io/aas/API/GetAllSubmodelElements/1/0/RC02): Returns all submodel elements including their hierarchy - - -## GetSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/GetSubmodelElementByPath/1/0/RC02](https://admin-shell.io/aas/API/GetSubmodelElementByPath/1/0/RC02): Returns a specific submodel element from the Submodel at a specified path - - -## PutSubmodel (Operation) - -[https://admin-shell.io/aas/API/PutSubmodel/1/0/RC02](https://admin-shell.io/aas/API/PutSubmodel/1/0/RC02): Updates the Submodel - - -## PostSubmodelElement (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelElement/1/0/RC02](https://admin-shell.io/aas/API/PostSubmodelElement/1/0/RC02): Creates a new submodel element as a child of the submodel. - - -## PostSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelElementByPath/1/0/RC02](https://admin-shell.io/aas/API/PostSubmodelElementByPath/1/0/RC02): Creates a new submodel element at a specified path within the submodel elements hierarchy. - - -## PutSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/PutSubmodelElementByPath/1/0/RC02](https://admin-shell.io/aas/API/PutSubmodelElementByPath/1/0/RC02): Updates an existing submodel element at a specified path within the submodel elements hierarchy - - -## SetSubmodelElementValueByPath (Operation) - -[https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/1/0/RC02](https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/1/0/RC02): Sets the value of the submodel element at a specified path according to the protocol-specific RAW-value payload - - -## DeleteSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/1/0/RC02](https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/1/0/RC02): Deletes a submodel element at a specified path within submodel elements hierarchy - - -## InvokeOperationSync (Operation) - -[https://admin-shell.io/aas/API/InvokeOperationSync/1/0/RC02](https://admin-shell.io/aas/API/InvokeOperationSync/1/0/RC02): Synchronously invokes an Operation at a specified path with a client timeout in ms - - -## InvokeOperationAsync (Operation) - -[https://admin-shell.io/aas/API/InvokeOperationAsync/1/0/RC02](https://admin-shell.io/aas/API/InvokeOperationAsync/1/0/RC02): Asynchronously invokes an Operation at a specified path with a client timeout in ms - - -## GetOperationAsyncResult (Operation) - -[https://admin-shell.io/aas/API/GetOperationAsyncResult/1/0/RC02](https://admin-shell.io/aas/API/GetOperationAsyncResult/1/0/RC02): Returns the OperationResult of an asynchronously invoked operation - - -## GenerateSerializationByIds (Operation) - -[https://admin-shell.io/aas/API/GenerateSerializationByIds/1/0/RC02](https://admin-shell.io/aas/API/GenerateSerializationByIds/1/0/RC02): Returns an appropriate serialization based on the specified format - - -## GetAllAASXPackageIds (Operation) - -[https://admin-shell.io/aas/API/GetAllAASXPackageIds/1/0/RC02](https://admin-shell.io/aas/API/GetAllAASXPackageIds/1/0/RC02): Returns a list of available AASX packages at the server - - -## GetAASXByPackageId (Operation) - -[https://admin-shell.io/aas/API/GetAASXByPackageId/1/0/RC02](https://admin-shell.io/aas/API/GetAASXByPackageId/1/0/RC02): Returns a specific AASX package from the server - - -## PostAASXPackage (Operation) - -[https://admin-shell.io/aas/API/PostAASXPackage/1/0/RC02](https://admin-shell.io/aas/API/PostAASXPackage/1/0/RC02): Creates an AASX package at the server - - -## PutAASXByPackageId (Operation) - -[https://admin-shell.io/aas/API/PutAASXByPackageId/1/0/RC02](https://admin-shell.io/aas/API/PutAASXByPackageId/1/0/RC02): Updates the AASX package at the server - - -## DeleteAASXByPackageId (Operation) - -[https://admin-shell.io/aas/API/DeleteAASXByPackageId/1/0/RC02](https://admin-shell.io/aas/API/DeleteAASXByPackageId/1/0/RC02): Deletes a specific AASX package - - -## GetAllAssetAdministrationShellDescriptors (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/1/0/RC02](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/1/0/RC02): Returns all Asset Administration Shell Descriptors from an AAS Registry - - -## GetAssetAdministrationShellDescriptorById (Operation) - -[https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/1/0/RC02](https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/1/0/RC02): Returns a specific Asset Administration Shell Descriptor from an AAS Registry - - -## PostAssetAdministrationShellDescriptor (Operation) - -[https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/1/0/RC02](https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/1/0/RC02): Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS at an AAS Registry - - -## PutAssetAdministrationShellDescriptorById (Operation) - -[https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/1/0/RC02](https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/1/0/RC02): Updates an existing Asset Administration Shell Descriptor - - -## DeleteAssetAdministrationShellDescriptorById (Operation) - -[https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/1/0/RC02](https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/1/0/RC02): Deletes an Asset Administration Shell Descriptor - - -## GetAllSubmodelDescriptors (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/1/0/RC02](https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/1/0/RC02): Returns all submodel descriptors - - -## GetSubmodelDescriptorById (Operation) - -[https://admin-shell.io/aas/API/GetSubmodelDescriptorById/1/0/RC02](https://admin-shell.io/aas/API/GetSubmodelDescriptorById/1/0/RC02): Returns a specific submodel descriptor - - -## PostSubmodelDescriptor (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelDescriptor/1/0/RC02](https://admin-shell.io/aas/API/PostSubmodelDescriptor/1/0/RC02): Creates a new submodel descriptor - - -## PutSubmodelDescriptorById (Operation) - -[https://admin-shell.io/aas/API/PutSubmodelDescriptorById/1/0/RC02](https://admin-shell.io/aas/API/PutSubmodelDescriptorById/1/0/RC02): Updates an existing submodel descriptor - - -## DeleteSubmodelDescriptorById (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/1/0/RC02](https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/1/0/RC02): Deletes a submodel descriptor - - -## GetAllAssetAdministrationShells (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/1/0/RC02](https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/1/0/RC02): Returns all Asset Administration Shells - - -## GetAssetAdministrationShellById (Operation) - -[https://admin-shell.io/aas/API/GetAssetAdministrationShellById/1/0/RC02](https://admin-shell.io/aas/API/GetAssetAdministrationShellById/1/0/RC02): Returns a specific Asset Administration Shell - - -## GetAllAssetAdministrationShellsByAssetId (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/1/0/RC02](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/1/0/RC02): Returns all Asset Administration Shells that are linked to a globally unique asset identifier or to specific asset ids. - - -## GetAllAssetAdministrationShellsByIdShort (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/1/0/RC02](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/1/0/RC02): -Returns all Asset Administration Shells with a specific idShort - - -## PostAssetAdministrationShell (Operation) - -[https://admin-shell.io/aas/API/PostAssetAdministrationShell/1/0/RC02](https://admin-shell.io/aas/API/PostAssetAdministrationShell/1/0/RC02): Creates a new Asset Administration Shell. - - -## PutAssetAdministrationShellById (Operation) - -[https://admin-shell.io/aas/API/PutAssetAdministrationShellById/1/0/RC02](https://admin-shell.io/aas/API/PutAssetAdministrationShellById/1/0/RC02): Updates an existing Asset Administration Shell - - -## DeleteAssetAdministrationShellById (Operation) - -[https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/1/0/RC02](https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/1/0/RC02): Deletes an Asset Administration Shell - - -## GetAllSubmodels (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodels/1/0/RC02](https://admin-shell.io/aas/API/GetAllSubmodels/1/0/RC02): Returns all Submodels - - -## GetSubmodelById (Operation) - -[https://admin-shell.io/aas/API/GetSubmodelById/1/0/RC02](https://admin-shell.io/aas/API/GetSubmodelById/1/0/RC02): Returns a specific Submodel - - -## GetAllSubmodelsBySemanticId (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/1/0/RC02](https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/1/0/RC02): Returns all Submodels with a specific SemanticId - - -## GetAllSubmodelsByIdShort (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/1/0/RC02](https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/1/0/RC02): Returns all Submodels with a specific idShort - - -## PostSubmodel (Operation) - -[https://admin-shell.io/aas/API/PostSubmodel/1/0/RC02](https://admin-shell.io/aas/API/PostSubmodel/1/0/RC02): Creates a new Submodel. - - -## PutSubmodelById (Operation) - -[https://admin-shell.io/aas/API/PutSubmodelById/1/0/RC02](https://admin-shell.io/aas/API/PutSubmodelById/1/0/RC02): Updates an existing Submodel - - -## DeleteSubmodelById (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelById/1/0/RC02](https://admin-shell.io/aas/API/DeleteSubmodelById/1/0/RC02): Deletes a Submodel - - -## GetAllConceptDescriptions (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptions/1/0/RC02](https://admin-shell.io/aas/API/GetAllConceptDescriptions/1/0/RC02): Returns all Concept Descriptions - - -## GetConceptDescriptionById (Operation) - -[https://admin-shell.io/aas/API/GetConceptDescriptionById/1/0/RC02](https://admin-shell.io/aas/API/GetConceptDescriptionById/1/0/RC02): Returns a specific Concept Description - - -## GetAllConceptDescriptionsByIdShort (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/1/0/RC02](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/1/0/RC02): Returns all Concept Descriptions with a specific idShort - - -## (Operation) - -[https://admin-shell.io/aas/API//1/0/RC02](https://admin-shell.io/aas/API//1/0/RC02): - - -## GetAllConceptDescriptionsByIsCaseOf (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/1/0/RC02](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/1/0/RC02): Returns all Concept Descriptions with a specific IsCaseOf-reference - - -## (Operation) - -[https://admin-shell.io/aas/API//1/0/RC02](https://admin-shell.io/aas/API//1/0/RC02): - - -## (Operation) - -[https://admin-shell.io/aas/API//1/0/RC02](https://admin-shell.io/aas/API//1/0/RC02): - - -## GetAllConceptDescriptionsByDataSpecificationReference (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/1/0/RC02](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/1/0/RC02): Returns all Concept Descriptions with a specific dataSpecification reference - - -## PostConceptDescription (Operation) - -[https://admin-shell.io/aas/API/PostConceptDescription/1/0/RC02](https://admin-shell.io/aas/API/PostConceptDescription/1/0/RC02): Creates a new Concept Description. - - -## PutConceptDescriptionById (Operation) - -[https://admin-shell.io/aas/API/PutConceptDescriptionById/1/0/RC02](https://admin-shell.io/aas/API/PutConceptDescriptionById/1/0/RC02): Updates an existing Concept Description - - -## DeleteConceptDescriptionById (Operation) - -[https://admin-shell.io/aas/API/DeleteConceptDescriptionById/1/0/RC02](https://admin-shell.io/aas/API/DeleteConceptDescriptionById/1/0/RC02): Deletes a Concept Description - - -## GetAllAssetAdministrationShellIdsByAssetLink (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/1/0/RC02](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/1/0/RC02): Returns a list of Asset Administration Shell ids based on Asset identifier key-value-pairs - - -## GetAllAssetLinksById (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetLinksById/1/0/RC02](https://admin-shell.io/aas/API/GetAllAssetLinksById/1/0/RC02): Returns a list of Asset identifier key-value-pairs based on an given Asset Administration Shell id - - -## PostAllAssetLinksById (Operation) - -[https://admin-shell.io/aas/API/PostAllAssetLinksById/1/0/RC02](https://admin-shell.io/aas/API/PostAllAssetLinksById/1/0/RC02): Creates or updates all Asset identifier key-value-pairs linked to an Asset Administration Shell to edit discoverable content - - -## DeleteAllAssetLinksById (Operation) - -[https://admin-shell.io/aas/API/DeleteAllAssetLinksById/1/0/RC02](https://admin-shell.io/aas/API/DeleteAllAssetLinksById/1/0/RC02): Deletes all Asset identifier key-value-pair linked to an Asset Administration Shell - - -## Descriptor (Class) - -[https://admin-shell.io/aas/API/DataTypes/Descriptor/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/Descriptor/1/0/RC02): The self-describing information of a network resource. - - -## AssetAdministrationShellDescriptor (Class) - -[https://admin-shell.io/aas/API/DataTypes/AssetAdministrationShellDescriptor/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/AssetAdministrationShellDescriptor/1/0/RC02): Descriptor of an Asset Administration Shell - - -## SubmodelDescriptor (Class) - -[https://admin-shell.io/aas/API/DataTypes/SubmodelDescriptor/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/SubmodelDescriptor/1/0/RC02): A descriptor of a submodel - - -## Endpoint (Class) - -[https://admin-shell.io/aas/API/DataTypes/Endpoint/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/Endpoint/1/0/RC02): The endpoint description of a network resource. - - -## ProtocolInformation (Class) - -[https://admin-shell.io/aas/API/DataTypes/ProtocolInformation/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/ProtocolInformation/1/0/RC02): The protocol information of a network resource endpoint will be defined in DIN SPEC 16593-2. - - -## Result (Class) - -[https://admin-shell.io/aas/API/DataTypes/Result/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/Result/1/0/RC02): The result object - - -## Message (Class) - -[https://admin-shell.io/aas/API/DataTypes/Message/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/Message/1/0/RC02): A message containing more information for the requester about a certain happening in the backend. - - -## MessageTypeEnum (Enumeration) - -[https://admin-shell.io/aas/API/DataTypes/MessageTypeEnum/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/MessageTypeEnum/1/0/RC02): The message type - - -## OperationRequest (Class) - -[https://admin-shell.io/aas/API/DataTypes/OperationRequest/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/OperationRequest/1/0/RC02): The operation request object - - -## OperationResult (Class) - -[https://admin-shell.io/aas/API/DataTypes/OperationResult/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/OperationResult/1/0/RC02): The operation’s invocation result object - - -## ExecutionState (Class) - -[https://admin-shell.io/aas/API/DataTypes/ExecutionState/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/ExecutionState/1/0/RC02): The operation’s invocation result state - - -## OperationHandle (Class) - -[https://admin-shell.io/aas/API/DataTypes/OperationHandle/1/0/RC02](https://admin-shell.io/aas/API/DataTypes/OperationHandle/1/0/RC02): The returned handle of an operation’s asynchronous invocation used to request the current state of the operation’s execution. - - - -## Contact - -The entries of this sub-namespace have been created by [Sebastian Bader](https://github.com/sebbader) -on behalf of the IDTA Working Group 'Asset Administration Shell'. -Contact via a [web form](https://www.plattform-i40.de/IP/Navigation/EN/ThePlatform/Contact/contact.html). - - -[1] S. Bader, B. Berres, B. Boss, A. Graf Gatterburg, M. Hoffmeister et al. -['Details of the Asset Administration Shell Part 2, Interoperability at Runtime – -Exchanging Information via Application Programming Interfaces'](), Version 1.0RC02, -Plattform Industrie 4.0, ZVEI, 2021 diff --git a/aas/API/1/0/RC03/README.md b/aas/API/1/0/RC03/README.md deleted file mode 100644 index 48efc8f..0000000 --- a/aas/API/1/0/RC03/README.md +++ /dev/null @@ -1,406 +0,0 @@ -# AAS API Version 3.0 Release Candidate 03 (3.0.RC03) - -This is the sub-namespace resevered for the Asset Administration Shell API -identifiers for version 3.0 (Candidate Release 03) [1]. - -## Introduction - -The content of this area is defined in the 'Details of the Asset Administration Shell - -Part 2'. Only identifiers that are defined in this document are allowed in this -sub-namespace. The identifiers are used to denote the different operations of -AAS interfaces. - -## Status: `Submitted` - -The content of the document and its identifiers have been accepted by the -IDTA Coordination Board. - - -## GetAssetAdministrationShell (Operation) - -[https://admin-shell.io/aas/API/GetAssetAdministrationShell/1/0/RC03](https://admin-shell.io/aas/API/GetAssetAdministrationShell/1/0/RC03): Returns the Asset Administration Shell - - -## PutAssetAdministrationShell (Operation) - -[https://admin-shell.io/aas/API/PutAssetAdministrationShell/1/0/RC03](https://admin-shell.io/aas/API/PutAssetAdministrationShell/1/0/RC03): Updates the Asset Administration Shell - - -## GetAllSubmodelReferences (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelReferences/1/0/RC03](https://admin-shell.io/aas/API/GetAllSubmodelReferences/1/0/RC03): Returns all Submodel References - - -## PostSubmodelReference (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelReference/1/0/RC03](https://admin-shell.io/aas/API/PostSubmodelReference/1/0/RC03): Creates a Submodel Reference at the Asset Administration Shell - - -## DeleteSubmodelReference (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelReference/1/0/RC03](https://admin-shell.io/aas/API/DeleteSubmodelReference/1/0/RC03): Deletes the Submodel Reference from the Asset Administration Shell - - -## GetAssetInformation (Operation) - -[https://admin-shell.io/aas/API/GetAssetInformation/1/0/RC03](https://admin-shell.io/aas/API/GetAssetInformation/1/0/RC03): Returns the Asset Information - - -## PutAssetInformation (Operation) - -[https://admin-shell.io/aas/API/PutAssetInformation/1/0/RC03](https://admin-shell.io/aas/API/PutAssetInformation/1/0/RC03): Updates the Asset Information - - -## GetSubmodel (Operation) - -[https://admin-shell.io/aas/API/GetSubmodel/1/0/RC03](https://admin-shell.io/aas/API/GetSubmodel/1/0/RC03): Returns the Submodel - - -## GetAllSubmodelElements (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelElements/1/0/RC03](https://admin-shell.io/aas/API/GetAllSubmodelElements/1/0/RC03): Returns all submodel elements including their hierarchy - - -## GetSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/GetSubmodelElementByPath/1/0/RC03](https://admin-shell.io/aas/API/GetSubmodelElementByPath/1/0/RC03): Returns a specific submodel element from the Submodel at a specified path - - -## GetFileByPath (Operation) - -[https://admin-shell.io/aas/API/GetFileByPath/1/0/RC03](https://admin-shell.io/aas/API/GetFileByPath/1/0/RC03): Returns a specific file content from the Submodel at a specified path - - -## PutSubmodel (Operation) - -[https://admin-shell.io/aas/API/PutSubmodel/1/0/RC03](https://admin-shell.io/aas/API/PutSubmodel/1/0/RC03): Updates the Submodel - - -## PostSubmodelElement (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelElement/1/0/RC03](https://admin-shell.io/aas/API/PostSubmodelElement/1/0/RC03): Creates a new submodel element as a child of the submodel. - - -## PostSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelElementByPath/1/0/RC03](https://admin-shell.io/aas/API/PostSubmodelElementByPath/1/0/RC03): Creates a new submodel element at a specified path within the submodel elements hierarchy. - - -## PutSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/PutSubmodelElementByPath/1/0/RC03](https://admin-shell.io/aas/API/PutSubmodelElementByPath/1/0/RC03): Updates an existing submodel element at a specified path within the submodel elements hierarchy - - -## PutFileByPath (Operation) - -[https://admin-shell.io/aas/API/PutFileByPath/1/0/RC03](https://admin-shell.io/aas/API/PutFileByPath/1/0/RC03): Updates the file content of an existing submodel element at a specified path within the submodel elements hierarchy - - -## SetSubmodelElementValueByPath (Operation) - -[https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/1/0/RC03](https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/1/0/RC03): Sets the value of the submodel element at a specified path according to the protocol-specific RAW-value payload - - -## DeleteSubmodelElementByPath (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/1/0/RC03](https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/1/0/RC03): Deletes a submodel element at a specified path within submodel elements hierarchy - - -## InvokeOperationSync (Operation) - -[https://admin-shell.io/aas/API/InvokeOperationSync/1/0/RC03](https://admin-shell.io/aas/API/InvokeOperationSync/1/0/RC03): Synchronously invokes an Operation at a specified path with a client timeout in ms - - -## InvokeOperationAsync (Operation) - -[https://admin-shell.io/aas/API/InvokeOperationAsync/1/0/RC03](https://admin-shell.io/aas/API/InvokeOperationAsync/1/0/RC03): Asynchronously invokes an Operation at a specified path with a client timeout in ms - - -## GetOperationAsyncResult (Operation) - -[https://admin-shell.io/aas/API/GetOperationAsyncResult/1/0/RC03](https://admin-shell.io/aas/API/GetOperationAsyncResult/1/0/RC03): Returns the OperationResult of an asynchronously invoked operation - - -## GenerateSerializationByIds (Operation) - -[https://admin-shell.io/aas/API/GenerateSerializationByIds/1/0/RC03](https://admin-shell.io/aas/API/GenerateSerializationByIds/1/0/RC03): Returns an appropriate serialization based on the specified format - - -## GetAllAASXPackageIds (Operation) - -[https://admin-shell.io/aas/API/GetAllAASXPackageIds/1/0/RC03](https://admin-shell.io/aas/API/GetAllAASXPackageIds/1/0/RC03): Returns a list of available AASX packages at the server - - -## GetAASXByPackageId (Operation) - -[https://admin-shell.io/aas/API/GetAASXByPackageId/1/0/RC03](https://admin-shell.io/aas/API/GetAASXByPackageId/1/0/RC03): Returns a specific AASX package from the server - - -## PostAASXPackage (Operation) - -[https://admin-shell.io/aas/API/PostAASXPackage/1/0/RC03](https://admin-shell.io/aas/API/PostAASXPackage/1/0/RC03): Creates an AASX package at the server - - -## PutAASXByPackageId (Operation) - -[https://admin-shell.io/aas/API/PutAASXByPackageId/1/0/RC03](https://admin-shell.io/aas/API/PutAASXByPackageId/1/0/RC03): Updates the AASX package at the server - - -## DeleteAASXByPackageId (Operation) - -[https://admin-shell.io/aas/API/DeleteAASXByPackageId/1/0/RC03](https://admin-shell.io/aas/API/DeleteAASXByPackageId/1/0/RC03): Deletes a specific AASX package - - -## GetAllAssetAdministrationShellDescriptors (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/1/0/RC03](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/1/0/RC03): Returns all Asset Administration Shell Descriptors from an AAS Registry - - -## GetAssetAdministrationShellDescriptorById (Operation) - -[https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/1/0/RC03](https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/1/0/RC03): Returns a specific Asset Administration Shell Descriptor from an AAS Registry - - -## PostAssetAdministrationShellDescriptor (Operation) - -[https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/1/0/RC03](https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/1/0/RC03): Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS at an AAS Registry - - -## PutAssetAdministrationShellDescriptorById (Operation) - -[https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/1/0/RC03](https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/1/0/RC03): Updates an existing Asset Administration Shell Descriptor - - -## DeleteAssetAdministrationShellDescriptorById (Operation) - -[https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/1/0/RC03](https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/1/0/RC03): Deletes an Asset Administration Shell Descriptor - - -## GetAllSubmodelDescriptors (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/1/0/RC03](https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/1/0/RC03): Returns all submodel descriptors - - -## GetSubmodelDescriptorById (Operation) - -[https://admin-shell.io/aas/API/GetSubmodelDescriptorById/1/0/RC03](https://admin-shell.io/aas/API/GetSubmodelDescriptorById/1/0/RC03): Returns a specific submodel descriptor - - -## PostSubmodelDescriptor (Operation) - -[https://admin-shell.io/aas/API/PostSubmodelDescriptor/1/0/RC03](https://admin-shell.io/aas/API/PostSubmodelDescriptor/1/0/RC03): Creates a new submodel descriptor - - -## PutSubmodelDescriptorById (Operation) - -[https://admin-shell.io/aas/API/PutSubmodelDescriptorById/1/0/RC03](https://admin-shell.io/aas/API/PutSubmodelDescriptorById/1/0/RC03): Updates an existing submodel descriptor - - -## DeleteSubmodelDescriptorById (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/1/0/RC03](https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/1/0/RC03): Deletes a submodel descriptor - - -## GetAllAssetAdministrationShells (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/1/0/RC03](https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/1/0/RC03): Returns all Asset Administration Shells - - -## GetAssetAdministrationShellById (Operation) - -[https://admin-shell.io/aas/API/GetAssetAdministrationShellById/1/0/RC03](https://admin-shell.io/aas/API/GetAssetAdministrationShellById/1/0/RC03): Returns a specific Asset Administration Shell - - -## GetAllAssetAdministrationShellsByAssetId (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/1/0/RC03](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/1/0/RC03): Returns all Asset Administration Shells that are linked to a globally unique asset identifier or to specific asset ids. - - -## GetAllAssetAdministrationShellsByIdShort (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/1/0/RC03](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/1/0/RC03): -Returns all Asset Administration Shells with a specific idShort - - -## PostAssetAdministrationShell (Operation) - -[https://admin-shell.io/aas/API/PostAssetAdministrationShell/1/0/RC03](https://admin-shell.io/aas/API/PostAssetAdministrationShell/1/0/RC03): Creates a new Asset Administration Shell. - - -## PutAssetAdministrationShellById (Operation) - -[https://admin-shell.io/aas/API/PutAssetAdministrationShellById/1/0/RC03](https://admin-shell.io/aas/API/PutAssetAdministrationShellById/1/0/RC03): Updates an existing Asset Administration Shell - - -## DeleteAssetAdministrationShellById (Operation) - -[https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/1/0/RC03](https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/1/0/RC03): Deletes an Asset Administration Shell - - -## GetAllSubmodels (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodels/1/0/RC03](https://admin-shell.io/aas/API/GetAllSubmodels/1/0/RC03): Returns all Submodels - - -## GetSubmodelById (Operation) - -[https://admin-shell.io/aas/API/GetSubmodelById/1/0/RC03](https://admin-shell.io/aas/API/GetSubmodelById/1/0/RC03): Returns a specific Submodel - - -## GetAllSubmodelsBySemanticId (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/1/0/RC03](https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/1/0/RC03): Returns all Submodels with a specific SemanticId - - -## GetAllSubmodelsByIdShort (Operation) - -[https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/1/0/RC03](https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/1/0/RC03): Returns all Submodels with a specific idShort - - -## PostSubmodel (Operation) - -[https://admin-shell.io/aas/API/PostSubmodel/1/0/RC03](https://admin-shell.io/aas/API/PostSubmodel/1/0/RC03): Creates a new Submodel. - - -## PutSubmodelById (Operation) - -[https://admin-shell.io/aas/API/PutSubmodelById/1/0/RC03](https://admin-shell.io/aas/API/PutSubmodelById/1/0/RC03): Updates an existing Submodel - - -## DeleteSubmodelById (Operation) - -[https://admin-shell.io/aas/API/DeleteSubmodelById/1/0/RC03](https://admin-shell.io/aas/API/DeleteSubmodelById/1/0/RC03): Deletes a Submodel - - -## GetAllConceptDescriptions (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptions/1/0/RC03](https://admin-shell.io/aas/API/GetAllConceptDescriptions/1/0/RC03): Returns all Concept Descriptions - - -## GetConceptDescriptionById (Operation) - -[https://admin-shell.io/aas/API/GetConceptDescriptionById/1/0/RC03](https://admin-shell.io/aas/API/GetConceptDescriptionById/1/0/RC03): Returns a specific Concept Description - - -## GetAllConceptDescriptionsByIdShort (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/1/0/RC03](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/1/0/RC03): Returns all Concept Descriptions with a specific idShort - - -## GetAllConceptDescriptionsByIsCaseOf (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/1/0/RC03](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/1/0/RC03): Returns all Concept Descriptions with a specific IsCaseOf-reference - - -## GetAllConceptDescriptionsByDataSpecificationReference (Operation) - -[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/1/0/RC03](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/1/0/RC03): Returns all Concept Descriptions with a specific dataSpecification reference - - -## PostConceptDescription (Operation) - -[https://admin-shell.io/aas/API/PostConceptDescription/1/0/RC03](https://admin-shell.io/aas/API/PostConceptDescription/1/0/RC03): Creates a new Concept Description. - - -## PutConceptDescriptionById (Operation) - -[https://admin-shell.io/aas/API/PutConceptDescriptionById/1/0/RC03](https://admin-shell.io/aas/API/PutConceptDescriptionById/1/0/RC03): Updates an existing Concept Description - - -## DeleteConceptDescriptionById (Operation) - -[https://admin-shell.io/aas/API/DeleteConceptDescriptionById/1/0/RC03](https://admin-shell.io/aas/API/DeleteConceptDescriptionById/1/0/RC03): Deletes a Concept Description - - -## GetAllAssetAdministrationShellIdsByAssetLink (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/1/0/RC03](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/1/0/RC03): Returns a list of Asset Administration Shell ids based on Asset identifier key-value-pairs - - -## GetAllAssetLinksById (Operation) - -[https://admin-shell.io/aas/API/GetAllAssetLinksById/1/0/RC03](https://admin-shell.io/aas/API/GetAllAssetLinksById/1/0/RC03): Returns a list of Asset identifier key-value-pairs based on an given Asset Administration Shell id - - -## PostAllAssetLinksById (Operation) - -[https://admin-shell.io/aas/API/PostAllAssetLinksById/1/0/RC03](https://admin-shell.io/aas/API/PostAllAssetLinksById/1/0/RC03): Creates or updates all Asset identifier key-value-pairs linked to an Asset Administration Shell to edit discoverable content - - -## DeleteAllAssetLinksById (Operation) - -[https://admin-shell.io/aas/API/DeleteAllAssetLinksById/1/0/RC03](https://admin-shell.io/aas/API/DeleteAllAssetLinksById/1/0/RC03): Deletes all Asset identifier key-value-pair linked to an Asset Administration Shell - - -## Descriptor (Class) - -[https://admin-shell.io/aas/API/DataTypes/Descriptor/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/Descriptor/1/0/RC03): The self-describing information of a network resource. - - -## AssetAdministrationShellDescriptor (Class) - -[https://admin-shell.io/aas/API/DataTypes/AssetAdministrationShellDescriptor/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/AssetAdministrationShellDescriptor/1/0/RC03): Descriptor of an Asset Administration Shell - - -## SubmodelDescriptor (Class) - -[https://admin-shell.io/aas/API/DataTypes/SubmodelDescriptor/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/SubmodelDescriptor/1/0/RC03): A descriptor of a submodel - - -## Endpoint (Class) - -[https://admin-shell.io/aas/API/DataTypes/Endpoint/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/Endpoint/1/0/RC03): The endpoint description of a network resource. - - -## ProtocolInformation (Class) - -[https://admin-shell.io/aas/API/DataTypes/ProtocolInformation/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/ProtocolInformation/1/0/RC03): The protocol information of a network resource endpoint will be defined in DIN SPEC 16593-2. - - -## Result (Class) - -[https://admin-shell.io/aas/API/DataTypes/Result/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/Result/1/0/RC03): The result object - - -## Message (Class) - -[https://admin-shell.io/aas/API/DataTypes/Message/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/Message/1/0/RC03): A message containing more information for the requester about a certain happening in the backend. - - -## MessageTypeEnum (Enumeration) - -[https://admin-shell.io/aas/API/DataTypes/MessageTypeEnum/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/MessageTypeEnum/1/0/RC03): The message type - - -## OperationRequest (Class) - -[https://admin-shell.io/aas/API/DataTypes/OperationRequest/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/OperationRequest/1/0/RC03): The operation request object - - -## OperationResult (Class) - -[https://admin-shell.io/aas/API/DataTypes/OperationResult/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/OperationResult/1/0/RC03): The operation’s invocation result object - - -## ExecutionState (Class) - -[https://admin-shell.io/aas/API/DataTypes/ExecutionState/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/ExecutionState/1/0/RC03): The operation’s invocation result state - - -## OperationHandle (Class) - -[https://admin-shell.io/aas/API/DataTypes/OperationHandle/1/0/RC03](https://admin-shell.io/aas/API/DataTypes/OperationHandle/1/0/RC03): The returned handle of an operation’s asynchronous invocation used to request the current state of the operation’s execution. - - - -## Contact - -The entries of this sub-namespace have been created by [Sebastian Bader](https://github.com/sebbader) -on behalf of the IDTA Working Group 'Asset Administration Shell'. -Contact via a [web form](https://www.plattform-i40.de/IP/Navigation/EN/ThePlatform/Contact/contact.html). - - -[1] S. Bader, B. Berres, B. Boss, A. Graf Gatterburg, M. Hoffmeister et al. -['Details of the Asset Administration Shell Part 2, Interoperability at Runtime – -Exchanging Information via Application Programming Interfaces'](), Version 1.0RC03, -Plattform Industrie 4.0 & IDTA, ZVEI, 2022 diff --git a/aas/API/1/0/README.md b/aas/API/1/0/README.md deleted file mode 100644 index b1ce5bb..0000000 --- a/aas/API/1/0/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# AAS (Asset Administration Shell) - -This is the sub-namespace resevered for the Asset Administration Shell - Part 2 Interoperability at Runtime Version 1.0. Identifiers used in the release candidates are available in the following folders: -- [V1.0RC01](./RC01/) -- [V1.0RC02](./RC02/) -- [V1.0RC03](./RC03/) - -The document 'Details of the Asset Administration Shell Part 2 - Interoperability at Runtime' [1] defines the meaning of its content and the used identifiers. - - -## Contact - -The entries of this sub-namespace have been created by [Sebastian Bader](https://github.com/sebbader) -on behalf of the IDTA Working Group 'Asset Administration Shell'. -Contact via a [web form](https://www.plattform-i40.de/IP/Navigation/EN/ThePlatform/Contact/contact.html). - - - - -[1] S. Bader, B. Berres, B. Boss, A. Graf Gatterburg, M. Hoffmeister et al. -Details of the Asset Administration Shell Part 2, Interoperability at Runtime – Exchanging Information via Application Programming Interfaces, Release Candidates of Version 1.0, -Plattform Industrie 4.0, ZVEI, 2023 diff --git a/aas/API/1/README.md b/aas/API/1/README.md deleted file mode 100644 index 45b77c4..0000000 --- a/aas/API/1/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# AAS (Asset Administration Shell) - -This is the sub-namespace resevered for the [Asset Administration Shell - Part 2 Interoperability at Runtime ](./0/README.md). - -The document 'Details of the Asset Administration Shell Part 2 - Interoperability at Runtime' [1] defines the meaning of its content and the used identifiers. - -[1] S. Bader, B. Berres, B. Boss, A. Graf Gatterburg, M. Hoffmeister et al. -['Details of the Asset Administration Shell Part 2, Interoperability at Runtime – Exchanging Information via Application Programming Interfaces'](), Version 1.0RC02, -Plattform Industrie 4.0, ZVEI, 2021 diff --git a/aas/API/3/0/README.md b/aas/API/3/0/README.md new file mode 100644 index 0000000..721a5a7 --- /dev/null +++ b/aas/API/3/0/README.md @@ -0,0 +1,402 @@ +# AAS (Asset Administration Shell) + +This is the sub-namespace reserved for the "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces", Version 3.0 (IDTA-01002-3-0). + +The document 'Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces', Version 3.0 (IDTA-01002-3-0) [1] defines the meaning of its content and the used identifiers. + + +## Introduction + +The content of this area is defined in the "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces", Version 3.0 (IDTA-01002-3-0). Only identifiers that are defined in this document are allowed in this +sub-namespace. The identifiers are used to denote the different operations of +AAS interfaces. + +## Status: `Submitted` + +The content of the document and its identifiers have been accepted by the +IDTA Coordination Board. + + +## GetAssetAdministrationShell (Operation) + +[https://admin-shell.io/aas/API/GetAssetAdministrationShell/3/0](https://admin-shell.io/aas/API/GetAssetAdministrationShell/3/0): Returns the Asset Administration Shell + + +## PutAssetAdministrationShell (Operation) + +[https://admin-shell.io/aas/API/PutAssetAdministrationShell/3/0](https://admin-shell.io/aas/API/PutAssetAdministrationShell/3/0): Updates the Asset Administration Shell + + +## GetAllSubmodelReferences (Operation) + +[https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0](https://admin-shell.io/aas/API/GetAllSubmodelReferences/3/0): Returns all Submodel References + + +## PostSubmodelReference (Operation) + +[https://admin-shell.io/aas/API/PostSubmodelReference/3/0](https://admin-shell.io/aas/API/PostSubmodelReference/3/0): Creates a Submodel Reference at the Asset Administration Shell + + +## DeleteSubmodelReference (Operation) + +[https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0](https://admin-shell.io/aas/API/DeleteSubmodelReference/3/0): Deletes the Submodel Reference from the Asset Administration Shell + + +## GetAssetInformation (Operation) + +[https://admin-shell.io/aas/API/GetAssetInformation/3/0](https://admin-shell.io/aas/API/GetAssetInformation/3/0): Returns the Asset Information + + +## PutAssetInformation (Operation) + +[https://admin-shell.io/aas/API/PutAssetInformation/3/0](https://admin-shell.io/aas/API/PutAssetInformation/3/0): Updates the Asset Information + + +## GetSubmodel (Operation) + +[https://admin-shell.io/aas/API/GetSubmodel/3/0](https://admin-shell.io/aas/API/GetSubmodel/3/0): Returns the Submodel + + +## GetAllSubmodelElements (Operation) + +[https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0](https://admin-shell.io/aas/API/GetAllSubmodelElements/3/0): Returns all submodel elements including their hierarchy + + +## GetSubmodelElementByPath (Operation) + +[https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0](https://admin-shell.io/aas/API/GetSubmodelElementByPath/3/0): Returns a specific submodel element from the Submodel at a specified path + + +## GetFileByPath (Operation) + +[https://admin-shell.io/aas/API/GetFileByPath/3/0](https://admin-shell.io/aas/API/GetFileByPath/3/0): Returns a specific file content from the Submodel at a specified path + + +## PutSubmodel (Operation) + +[https://admin-shell.io/aas/API/PutSubmodel/3/0](https://admin-shell.io/aas/API/PutSubmodel/3/0): Updates the Submodel + + +## PostSubmodelElement (Operation) + +[https://admin-shell.io/aas/API/PostSubmodelElement/3/0](https://admin-shell.io/aas/API/PostSubmodelElement/3/0): Creates a new submodel element as a child of the submodel. + + +## PostSubmodelElementByPath (Operation) + +[https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0](https://admin-shell.io/aas/API/PostSubmodelElementByPath/3/0): Creates a new submodel element at a specified path within the submodel elements hierarchy. + + +## PutSubmodelElementByPath (Operation) + +[https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0](https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0): Updates an existing submodel element at a specified path within the submodel elements hierarchy + + +## PutFileByPath (Operation) + +[https://admin-shell.io/aas/API/PutFileByPath/3/0](https://admin-shell.io/aas/API/PutFileByPath/3/0): Updates the file content of an existing submodel element at a specified path within the submodel elements hierarchy + + +## SetSubmodelElementValueByPath (Operation) + +[https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0](https://admin-shell.io/aas/API/SetSubmodelElementValueByPath/3/0): Sets the value of the submodel element at a specified path according to the protocol-specific RAW-value payload + + +## DeleteSubmodelElementByPath (Operation) + +[https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0](https://admin-shell.io/aas/API/DeleteSubmodelElementByPath/3/0): Deletes a submodel element at a specified path within submodel elements hierarchy + + +## InvokeOperationSync (Operation) + +[https://admin-shell.io/aas/API/InvokeOperationSync/3/0](https://admin-shell.io/aas/API/InvokeOperationSync/3/0): Synchronously invokes an Operation at a specified path with a client timeout in ms + + +## InvokeOperationAsync (Operation) + +[https://admin-shell.io/aas/API/InvokeOperationAsync/3/0](https://admin-shell.io/aas/API/InvokeOperationAsync/3/0): Asynchronously invokes an Operation at a specified path with a client timeout in ms + + +## GetOperationAsyncResult (Operation) + +[https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0](https://admin-shell.io/aas/API/GetOperationAsyncResult/3/0): Returns the OperationResult of an asynchronously invoked operation + + +## GenerateSerializationByIds (Operation) + +[https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0](https://admin-shell.io/aas/API/GenerateSerializationByIds/3/0): Returns an appropriate serialization based on the specified format + + +## GetAllAASXPackageIds (Operation) + +[https://admin-shell.io/aas/API/GetAllAASXPackageIds/3/0](https://admin-shell.io/aas/API/GetAllAASXPackageIds/3/0): Returns a list of available AASX packages at the server + + +## GetAASXByPackageId (Operation) + +[https://admin-shell.io/aas/API/GetAASXByPackageId/3/0](https://admin-shell.io/aas/API/GetAASXByPackageId/3/0): Returns a specific AASX package from the server + + +## PostAASXPackage (Operation) + +[https://admin-shell.io/aas/API/PostAASXPackage/3/0](https://admin-shell.io/aas/API/PostAASXPackage/3/0): Creates an AASX package at the server + + +## PutAASXByPackageId (Operation) + +[https://admin-shell.io/aas/API/PutAASXByPackageId/3/0](https://admin-shell.io/aas/API/PutAASXByPackageId/3/0): Updates the AASX package at the server + + +## DeleteAASXByPackageId (Operation) + +[https://admin-shell.io/aas/API/DeleteAASXByPackageId/3/0](https://admin-shell.io/aas/API/DeleteAASXByPackageId/3/0): Deletes a specific AASX package + + +## GetAllAssetAdministrationShellDescriptors (Operation) + +[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0): Returns all Asset Administration Shell Descriptors from an AAS Registry + + +## GetAssetAdministrationShellDescriptorById (Operation) + +[https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/0](https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/0): Returns a specific Asset Administration Shell Descriptor from an AAS Registry + + +## PostAssetAdministrationShellDescriptor (Operation) + +[https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/3/0](https://admin-shell.io/aas/API/PostAssetAdministrationShellDescriptor/3/0): Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS at an AAS Registry + + +## PutAssetAdministrationShellDescriptorById (Operation) + +[https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/3/0](https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/3/0): Updates an existing Asset Administration Shell Descriptor + + +## DeleteAssetAdministrationShellDescriptorById (Operation) + +[https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/3/0](https://admin-shell.io/aas/API/DeleteAssetAdministrationShellDescriptorById/3/0): Deletes an Asset Administration Shell Descriptor + + +## GetAllSubmodelDescriptors (Operation) + +[https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0](https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0): Returns all submodel descriptors + + +## GetSubmodelDescriptorById (Operation) + +[https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0](https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0): Returns a specific submodel descriptor + + +## PostSubmodelDescriptor (Operation) + +[https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0](https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0): Creates a new submodel descriptor + + +## PutSubmodelDescriptorById (Operation) + +[https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0](https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0): Updates an existing submodel descriptor + + +## DeleteSubmodelDescriptorById (Operation) + +[https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0](https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0): Deletes a submodel descriptor + + +## GetAllAssetAdministrationShells (Operation) + +[https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0](https://admin-shell.io/aas/API/GetAllAssetAdministrationShells/3/0): Returns all Asset Administration Shells + + +## GetAssetAdministrationShellById (Operation) + +[https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0](https://admin-shell.io/aas/API/GetAssetAdministrationShellById/3/0): Returns a specific Asset Administration Shell + + +## GetAllAssetAdministrationShellsByAssetId (Operation) + +[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByAssetId/3/0): Returns all Asset Administration Shells that are linked to a globally unique asset identifier or to specific asset ids. + + +## GetAllAssetAdministrationShellsByIdShort (Operation) + +[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellsByIdShort/3/0): +Returns all Asset Administration Shells with a specific idShort + + +## PostAssetAdministrationShell (Operation) + +[https://admin-shell.io/aas/API/PostAssetAdministrationShell/3/0](https://admin-shell.io/aas/API/PostAssetAdministrationShell/3/0): Creates a new Asset Administration Shell. + + +## PutAssetAdministrationShellById (Operation) + +[https://admin-shell.io/aas/API/PutAssetAdministrationShellById/3/0](https://admin-shell.io/aas/API/PutAssetAdministrationShellById/3/0): Updates an existing Asset Administration Shell + + +## DeleteAssetAdministrationShellById (Operation) + +[https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/3/0](https://admin-shell.io/aas/API/DeleteAssetAdministrationShellById/3/0): Deletes an Asset Administration Shell + + +## GetAllSubmodels (Operation) + +[https://admin-shell.io/aas/API/GetAllSubmodels/3/0](https://admin-shell.io/aas/API/GetAllSubmodels/3/0): Returns all Submodels + + +## GetSubmodelById (Operation) + +[https://admin-shell.io/aas/API/GetSubmodelById/3/0](https://admin-shell.io/aas/API/GetSubmodelById/3/0): Returns a specific Submodel + + +## GetAllSubmodelsBySemanticId (Operation) + +[https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0](https://admin-shell.io/aas/API/GetAllSubmodelsBySemanticId/3/0): Returns all Submodels with a specific SemanticId + + +## GetAllSubmodelsByIdShort (Operation) + +[https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0](https://admin-shell.io/aas/API/GetAllSubmodelsByIdShort/3/0): Returns all Submodels with a specific idShort + + +## PostSubmodel (Operation) + +[https://admin-shell.io/aas/API/PostSubmodel/3/0](https://admin-shell.io/aas/API/PostSubmodel/3/0): Creates a new Submodel. + + +## PutSubmodelById (Operation) + +[https://admin-shell.io/aas/API/PutSubmodelById/3/0](https://admin-shell.io/aas/API/PutSubmodelById/3/0): Updates an existing Submodel + + +## DeleteSubmodelById (Operation) + +[https://admin-shell.io/aas/API/DeleteSubmodelById/3/0](https://admin-shell.io/aas/API/DeleteSubmodelById/3/0): Deletes a Submodel + + +## GetAllConceptDescriptions (Operation) + +[https://admin-shell.io/aas/API/GetAllConceptDescriptions/3/0](https://admin-shell.io/aas/API/GetAllConceptDescriptions/3/0): Returns all Concept Descriptions + + +## GetConceptDescriptionById (Operation) + +[https://admin-shell.io/aas/API/GetConceptDescriptionById/3/0](https://admin-shell.io/aas/API/GetConceptDescriptionById/3/0): Returns a specific Concept Description + + +## GetAllConceptDescriptionsByIdShort (Operation) + +[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/3/0](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIdShort/3/0): Returns all Concept Descriptions with a specific idShort + + +## GetAllConceptDescriptionsByIsCaseOf (Operation) + +[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/3/0](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByIsCaseOf/3/0): Returns all Concept Descriptions with a specific IsCaseOf-reference + + +## GetAllConceptDescriptionsByDataSpecificationReference (Operation) + +[https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/3/0](https://admin-shell.io/aas/API/GetAllConceptDescriptionsByDataSpecificationReference/3/0): Returns all Concept Descriptions with a specific dataSpecification reference + + +## PostConceptDescription (Operation) + +[https://admin-shell.io/aas/API/PostConceptDescription/3/0](https://admin-shell.io/aas/API/PostConceptDescription/3/0): Creates a new Concept Description. + + +## PutConceptDescriptionById (Operation) + +[https://admin-shell.io/aas/API/PutConceptDescriptionById/3/0](https://admin-shell.io/aas/API/PutConceptDescriptionById/3/0): Updates an existing Concept Description + + +## DeleteConceptDescriptionById (Operation) + +[https://admin-shell.io/aas/API/DeleteConceptDescriptionById/3/0](https://admin-shell.io/aas/API/DeleteConceptDescriptionById/3/0): Deletes a Concept Description + + +## GetAllAssetAdministrationShellIdsByAssetLink (Operation) + +[https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/3/0](https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/3/0): Returns a list of Asset Administration Shell ids based on Asset identifier key-value-pairs + + +## GetAllAssetLinksById (Operation) + +[https://admin-shell.io/aas/API/GetAllAssetLinksById/3/0](https://admin-shell.io/aas/API/GetAllAssetLinksById/3/0): Returns a list of Asset identifier key-value-pairs based on an given Asset Administration Shell id + + +## PostAllAssetLinksById (Operation) + +[https://admin-shell.io/aas/API/PostAllAssetLinksById/3/0](https://admin-shell.io/aas/API/PostAllAssetLinksById/3/0): Creates or updates all Asset identifier key-value-pairs linked to an Asset Administration Shell to edit discoverable content + + +## DeleteAllAssetLinksById (Operation) + +[https://admin-shell.io/aas/API/DeleteAllAssetLinksById/3/0](https://admin-shell.io/aas/API/DeleteAllAssetLinksById/3/0): Deletes all Asset identifier key-value-pair linked to an Asset Administration Shell + + +## Descriptor (Class) + +[https://admin-shell.io/aas/API/DataTypes/Descriptor/3/0](https://admin-shell.io/aas/API/DataTypes/Descriptor/3/0): The self-describing information of a network resource. + + +## AssetAdministrationShellDescriptor (Class) + +[https://admin-shell.io/aas/API/DataTypes/AssetAdministrationShellDescriptor/3/0](https://admin-shell.io/aas/API/DataTypes/AssetAdministrationShellDescriptor/3/0): Descriptor of an Asset Administration Shell + + +## SubmodelDescriptor (Class) + +[https://admin-shell.io/aas/API/DataTypes/SubmodelDescriptor/3/0](https://admin-shell.io/aas/API/DataTypes/SubmodelDescriptor/3/0): A descriptor of a submodel + + +## Endpoint (Class) + +[https://admin-shell.io/aas/API/DataTypes/Endpoint/3/0](https://admin-shell.io/aas/API/DataTypes/Endpoint/3/0): The endpoint description of a network resource + + +## ProtocolInformation (Class) + +[https://admin-shell.io/aas/API/DataTypes/ProtocolInformation/3/0](https://admin-shell.io/aas/API/DataTypes/ProtocolInformation/3/0): The protocol information of a network resource endpoint + + +## Result (Class) + +[https://admin-shell.io/aas/API/DataTypes/Result/3/0](https://admin-shell.io/aas/API/DataTypes/Result/3/0): The result object + + +## Message (Class) + +[https://admin-shell.io/aas/API/DataTypes/Message/3/0](https://admin-shell.io/aas/API/DataTypes/Message/3/0): A message containing more information for the requester about a certain happening in the backend. + + +## MessageTypeEnum (Enumeration) + +[https://admin-shell.io/aas/API/DataTypes/MessageTypeEnum/3/0](https://admin-shell.io/aas/API/DataTypes/MessageTypeEnum/3/0): The message type + + +## OperationRequest (Class) + +[https://admin-shell.io/aas/API/DataTypes/OperationRequest/3/0](https://admin-shell.io/aas/API/DataTypes/OperationRequest/3/0): The operation request object + + +## OperationResult (Class) + +[https://admin-shell.io/aas/API/DataTypes/OperationResult/3/0](https://admin-shell.io/aas/API/DataTypes/OperationResult/3/0): The operation’s invocation result object + + +## ExecutionState (Class) + +[https://admin-shell.io/aas/API/DataTypes/ExecutionState/3/0](https://admin-shell.io/aas/API/DataTypes/ExecutionState/3/0): The operation’s invocation result state + + +## OperationHandle (Class) + +[https://admin-shell.io/aas/API/DataTypes/OperationHandle/3/0](https://admin-shell.io/aas/API/DataTypes/OperationHandle/3/0): The returned handle of an operation’s asynchronous invocation used to request the current state of the operation’s execution. + + +## Contact + +The entries of this sub-namespace have been created by the Workstream "Specification of the Asset Administration Shell" in the IDTA Working Group 'Open Technology'. +Contact via a [web form](https://industrialdigitaltwin.org/en/contact). + + +[1] ['Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces'](https://industrialdigitaltwin.org/en/content-hub/aasspecifications), Version 3.0, IDTA-01002-3-0, 2023 \ No newline at end of file diff --git a/aas/API/3/README.md b/aas/API/3/README.md new file mode 100644 index 0000000..b15e809 --- /dev/null +++ b/aas/API/3/README.md @@ -0,0 +1,14 @@ +# AAS (Asset Administration Shell) + +This is the sub-namespace reserved for the [Asset Administration Shell - Part 2 Application Programming Interfaces](./0/README.md). + +The document 'Specification of the Asset Administration Shell Part 2 - Application Programming Interfaces' [1] defines the meaning of its content and the used identifiers. + + +## Contact + +The entries of this sub-namespace have been created by the Workstream "Specification of the Asset Administration Shell" in the IDTA Working Group 'Open Technology'. +Contact via a [web form](https://industrialdigitaltwin.org/en/contact). + + +[1] ['Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces'](https://industrialdigitaltwin.org/en/content-hub/aasspecifications), Version 3.0, IDTA-01002-3-0, 2023 \ No newline at end of file diff --git a/aas/API/README.md b/aas/API/README.md index ba7eac4..8faecf6 100644 --- a/aas/API/README.md +++ b/aas/API/README.md @@ -1,9 +1,18 @@ # AAS (Asset Administration Shell) -This is the sub-namespace resevered for the [Asset Administration Shell - Part 2 Interoperability at Runtime Version 1.0](./1/0/README.md). +This is the sub-namespace reserved for the "Asset Administration Shell - Part 2: Application Programming Interfaces". -The document 'Details of the Asset Administration Shell Part 2 - Interoperability at Runtime' [1] defines the meaning of its content and the used identifiers. +The document 'Details of the Asset Administration Shell Part 2: Application Programming Interfaces' [1] defines the meaning of its content and the used identifiers. -[1] S. Bader, B. Berres, B. Boss, A. Graf Gatterburg, M. Hoffmeister et al. -['Details of the Asset Administration Shell Part 2, Interoperability at Runtime – Exchanging Information via Application Programming Interfaces'](), Version 1.0RC02, -Plattform Industrie 4.0, ZVEI, 2021 +## Content + +The follwing sub-namespaces are declared: +- [V3](./3/) + +## Contact + +The entries of this sub-namespace have been created by the Workstream "Specification of the Asset Administration Shell" in the IDTA Working Group 'Open Technology'. +Contact via a [web form](https://industrialdigitaltwin.org/en/contact). + + +[1] ['Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces'](https://industrialdigitaltwin.org/en/content-hub/aasspecifications), Version 3.0, IDTA-01002-3-0, 2023 \ No newline at end of file diff --git a/aas/README.md b/aas/README.md index 66fef2c..0b34c1f 100644 --- a/aas/README.md +++ b/aas/README.md @@ -13,27 +13,20 @@ third is currently finalized: - [Release 1](/aas/1/0/README.md) from 2018 [1] - [Release 2](/aas/2/0/README.md) from 2019 [2] - [Revision 2.0.1](/aas/2/0/1/README.md) from May 2020 [3] -- [Candidate Release of version 3.0](./3/0/RC01/README.md) 2020 [4] +- [Version 3.0](./3/0/README.md) 2020 [4] -Part 2 will be released in [Version 1](./API/1/0/README.md) before the end of 2022. +Part 2 (Application Programming Interfaces) is available in the sub-namespace [API](./API/). -[1] B. Boss, M. Hoffmeister, T. Deppe, F. Pethig, E. Barnstedt et al. -['Details of the Asset Administration Shell Part 1, The exchange of information -between partners in the value chain of Industrie 4.0'](), Version 1.0, -Plattform Industrie 4.0, ZVEI, 2018 +[4] ['Specification of the Asset Administration Shell - Part 1: Metamodel'](https://industrialdigitaltwin.org/en/content-hub/aasspecifications), Version 3.0, -[2] B. Boss, M. Hoffmeister, T. Deppe, F. Pethig, S. Bader, E. Barnstedt et al. -['Details of the Asset Administration Shell Part 1, The exchange of information +[2] ['Details of the Asset Administration Shell Part 1, The exchange of information between partners in the value chain of Industrie 4.0'](), Version 2.0, Plattform Industrie 4.0, ZVEI, 2019 -[3] B. Boss, M. Hoffmeister, T. Deppe, F. Pethig, S. Bader, E. Barnstedt et al. -'Details of the Asset Administration Shell Part 1, The exchange of information +[3] 'Details of the Asset Administration Shell Part 1, The exchange of information between partners in the value chain of Industrie 4.0', Version 2.0.1, Plattform Industrie 4.0, ZVEI, 2020 -[4] B. Boss, M. Hoffmeister, T. Deppe, F. Pethig, S. Bader, E. Barnstedt et al. -['Details of the Asset Administration Shell Part 1, The exchange of information -between partners in the value chain of Industrie 4.0'](https://www.plattform-i40.de/IP/Redaktion/EN/Downloads/Publikation/Details_of_the_Asset_Administration_Shell_Part1_V3.html), Version 3.0.RC01, +[4] ['Specification of the Asset Administration Shell - Part 1: Metamodel'](https://industrialdigitaltwin.org/en/content-hub/aasspecificationsl), Version 3.0, Plattform Industrie 4.0, ZVEI, 2020