aas-specs-api

IDTA-01002 - APIs of the Asset Administration Shell

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

📚 Interactive API Documentation

View and explore the API specifications using our interactive documentation site:

🌐 View API Documentation

The documentation site provides:

📖 Interactive Swagger UI - Try out API endpoints directly in your browser
📘 Redoc Documentation - Beautiful, readable API reference
🔍 Search & Filter - Quickly find the API you need
📱 Mobile Responsive - Works on all devices

Note: Replace the URL above with your actual GitHub Pages URL after deployment. See docs/SETUP.md for deployment instructions.

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 in the SwaggerHub organization Plattform_i40. All published SwaggerHub APIs are synchronized all the time with the respective folders in this repository using the GitHub Integration feature. In particular, the following APIs are contained:

API SPEC	GitHub	SwaggerHub
Entire-API-Collection	Link	Link	https://app.swaggerhub.com/apis/Plattform_i40/Entire-API-Collection
Asset Administration Shell Registry Service Specification	Link	Link	https://app.swaggerhub.com/apis/Plattform_i40/RegistryServiceSpecification/V3.2.0_SSP-001
Asset Administration Shell Repository Service Specification	Link	Link	https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRepositoryServiceSpecification/V3.2.0_SSP-001
Asset Administration Shell Service Specification	Link	Link	https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellServiceSpecification/V3.2.0_SSP-001
Submodel Registry Service Specification	Link	Link	https://app.swaggerhub.com/apis/Plattform_i40/SubmodelRegistryServiceSpecification/V3.2.0_SSP-001
Submodel Repository Service Specification	Link	Link	https://app.swaggerhub.com/apis/Plattform_i40/SubmodelRepositoryServiceSpecification/V3.2.0_SSP-001
Submodel Service Specification	Link	Link	https://app.swaggerhub.com/apis/Plattform_i40/SubmodelServiceSpecification/V3.2.0_SSP-001
Discovery Service Specification	Link	Link	https://app.swaggerhub.com/apis/Plattform_i40/DiscoveryServiceSpecification/V3.2.0_SSP-001
Concept Description Repository Service Specification	Link	Link	https://app.swaggerhub.com/apis/Plattform_i40/ConceptDescriptionRepositoryServiceSpecification/V3.2.0_SSP-001
Aasx-File-Server Service Specification	Link	Link

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, and marked with the Published tag in SwaggerHub. Working versions may be marked as private in SwaggerHub and therefore may not be visible to the public audience yet. In this repository, working versions appear as branches named after the target release version.
Note: In order to synchronize with the same GitHub branch, all versions should follow the exact same pattern.

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 bugfix 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.2 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.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.

SwaggerHub GitHub Synchronization

SwaggerHub requires a GitHub Access Token with repo permissions. It is good practice that the selected token has a defined expiration date. Therefore, at some point in time when the current token expires, the synchronization will fail and a new token needs to be added through the IDTA repository management team.

This site is open source. Improve this page.