Part 2: Application Programming Interfaces (IDTA-01002-3-1) - in progress

Specification of the Asset Administration Shell

This specification is part of the Asset Administration Shell Specification series.

Version

This is version 3.2.0 of the specification IDTA-01002.

Previous version: 3.1.3

Alignment with other AAS Specifications

This version of IDTA-01002 (v3.2) is designed to be used together with the following companion specifications:

Dependency Specification Aligned Version Notes

x

IDTA-01001 Part 1: Metamodel

v3.2

API:

  • defines payload of many API operations like GetAssetAdministrationShell, GetSubmodel etc. (collected in Part1-MetaModel-Schemas)

  • is the basis for derived data types for payload like AssetLink, SubmodelDescriptor etc. used in Registry or Discovery API operations

  • defines mapping rules for serializations like Value, Metadata etc.

Query Language:

  • defines the classes referenced by $aas, $sm, $sme, $cd

  • defines the attributes used in conditions like semanticId, specificAssetIds etc.

x

IDTA-01003-a Part 3a: Data Specification Template IEC61360

v3.1

is integrated into the schema of Part 1

x

IDTA-01003-b Part 3b: Data Specification Template Measurement Units

v3.0

is integrated into the schema of Part 1

x

IDTA-01004 Part 4: Security

v3.1

API:

  • security measurements shall be applied to API

  • access control rules shall be implemented (Note: if an implementation only supports a subset of access control rules this shall be specified)

Query Language:

  • IDTA-01002 and IDTA-01004 share the same BNF grammar and JSON Schema for formula expressions; see Query Language and the Access Rule Model in IDTA-01004.

x

IDTA-01005 Part 5: Package File Format (AASX)

v3.2

defines return object for API operations like GetAASXByPackageId

Bugfix (patch) releases of aligned specifications shall be substituted.

Notice

Copyright: Industrial Digital Twin Association e.V. (IDTA)

IDTA Number: IDTA-01002

Version: 3.2.0

DOI: https://doi.org/10.62628/IDTA.01002-3-2

This work is licensed under a Creative Commons Attribution 4.0 International License.

SPDX-License-Identifier: CC-BY-4.0

How to Get in Contact

Contact: IDTA

Sources: GitHub

Feedback:

Editorial Notes

History

This document (version 3.2) was produced by the Work Stream "Specification of the Asset Administration Shell" of the Working Group "Open Technology" of the Industrial Digital Twin Association (IDTA).

Version 3.1 was finalized in May 2025 by the Work Stream "Specification of the Asset Administration Shell" of the Working Group "Open Technology" of the Industrial Digital Twin Association (IDTA). It is the first version published as html document and maintained completely open source.

Version 3.0, the first release of the API, was finalized from November 2021 to May 2023 by the joint sub working group "Asset Administration Shell" of the working group "Reference Architectures, Standards and Norms" of the Plattform Industrie 4.0 and the working group "Open Technology" of the Industrial Digital Twin Association (IDTA).

Earlier versions of this document were release candidates and used the version 1.0. It has been decided in the meantime that this first release will start with version 3.0, in line with the related release of the metamodel.

Version 1.0 RC02 of this document was developed from November 2020 to November 2021 by the joint working groups “Asset Administration Shell” and “Infrastructure of the Asset Administration Shell” of the Plattform Industrie 4.0 working group “Reference Architectures, Standards and Norms“.

Version 1.0 RC01 of this document was developed from December 2019 to November 2020 by the sub working groups “Asset Administration Shell” and “Infrastructure of the Asset Administration Shell” of the Plattform Industrie 4.0 working group “Reference Architectures, Standards and Norms“.

This document is Part 2 of the document series “Specification of the Asset Administration Shell”.

Versioning

This specification is versioned using Semantic Versioning 2.0.0 (semver) and follows the semver specification [9] with the following deviation: Bugfix versions are not necessarily backward compatible.

Conformance

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 RFC2119 RFC8174[1]:

  • MUST word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.

  • MUST NOT This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.

  • SHOULD This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.

  • SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.

  • MAY This word, or the adjective "OPTIONAL", mean that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)