IDTA-01002 - APIs of the Asset Administration Shell

July 20, 2026 · View on GitHub

Creative Commons License

This repository contains specifications of the APIs of the Asset Administration Shell (AAS), including the normative OpenAPI files of the AAS HTTP/REST API.

Industrial Digital Twin Association (IDTA)

Governance of the specification is done in the working group Open Technology of the IDTA

The specification number is: IDTA-01002

Content

This repository provides the OpenAPI files published via GitHub Pages. For legacy reasons, versions up to V3.1.3 are also available in the SwaggerHub organization Plattform_i40. In particular, the following APIs are contained:

API SPECGitHubGitHub PagesSwaggerHub 1
Entire-API-CollectionLinkLinkLink
Asset Administration Shell Registry Service SpecificationLinkLinkLink
Asset Administration Shell Repository Service SpecificationLinkLinkLink
Asset Administration Shell Service SpecificationLinkLinkLink
Submodel Registry Service SpecificationLinkLinkLink
Submodel Repository Service SpecificationLinkLinkLink
Submodel Service SpecificationLinkLinkLink
Discovery Service SpecificationLinkLinkLink
Concept Description Repository Service SpecificationLinkLinkLink
Aasx-File-Server Service SpecificationLinkLinkLink

The following domains are also published:

API SPECGitHubGitHub PagesSwaggerHub 1
Part1-MetaModel-Schemas DomainLinkLinkLink
Part2-API-Schemas DomainLinkLinkLink
DINSPEC16593-Schemas Domain (Deprecated)LinkLinkLink

The sources of the specification, both website and PDF document, are maintained in the documentation folder. The different versions are identified through the respective release tags, while the latest state on the main branch always represents a SNAPSHOT version.

API Versions in GitHub Branches

The main branch contains the latest released version of all APIs and Domains. Current and previously released states are tagged with the corresponding release version in this repository. Working versions appear as branches named after the target release version.

Releases

The following versioning scheme is applied for release tags: 'V<major>.<minor>.<patch>'. Major versions indicate breaking changes while minor updates are backward compatible. The patch position is increased whenever bugfixes need to be applied. The following release contains the latest version of the AAS schemas (see also the releases section of this repository):

  • 3.2.0 is the latest release for the V3.2.0 version of the AAS APIs, containing the normative specification and schemas of IDTA-01002-3-2.
  • Use this release if you want to work with the latest specified AAS version.

Previous releases:

  • 3.1.3 is the latest bugfix release for the V3.1 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.1.3".

  • 3.1.2 is a bugfix release for the V3.1 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.1.2".

  • 3.1.1 is a bugfix release for the V3.1 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.1.1".

  • 3.1.0 is the release for the V3.1 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.1.0".

  • 3.0.4 is the latest bugfix release for the V3.0.4 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.0.4".

  • 3.0.3 is the bugfix release for the V3.0.3 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.0.3".

  • 3.0.2 is the bugfix release for the V3.0.2 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.0.2".

  • 3.0.1 is the bugfix release for the V3.0.1 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.0.1".

  • 3.0 is the first major release for the AAS APIs, containing the normative API descriptions for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.0".

Contributing

Feature requests, reports about inconsistencies, mistakes etc. are highly welcome! Please submit a new issue.

If you want to contribute, see CONTRIBUTING.md.

Footnotes

  1. Swaggerhub links are only provided for legacy reasons. Latest OpenAPI versions are only hosted via Github Pages. 2